## Module

# Struct Module

Source

    pub(crate) struct Module<'hir> {
        pub(crate) name: Symbol,
        pub(crate) where_inner: Span,
        pub(crate) mods: Vec<Module<'hir>>,
        pub(crate) def_id: LocalDefId,
        pub(crate) renamed: Option<Symbol>,
        pub(crate) import_id: Option<LocalDefId>,
        pub(crate) items: FxIndexMap<(LocalDefId, Option<Symbol>), (&'hir Item<'hir>, Option<Symbol>, Vec<LocalDefId>)>,
        pub(crate) inlined_foreigns: FxIndexMap<(DefId, Option<Symbol>), (Res, LocalDefId)>,
        pub(crate) foreigns: Vec<(&'hir ForeignItem<'hir>, Option<Symbol>, Option<LocalDefId>)>,
    }

Expand description

This module is used to store stuff from Rust’s AST in a more convenient manner (and with prettier names) before cleaning.

## Fields§

§`name: Symbol`§`where_inner: Span`§`mods: Vec<Module<'hir>>`§`def_id: LocalDefId`§`renamed: Option<Symbol>`§`import_id: Option<LocalDefId>`§`items: FxIndexMap<(LocalDefId, Option<Symbol>), (&'hir Item<'hir>, Option<Symbol>, Vec<LocalDefId>)>`

The key is the item `ItemId` and the value is: (item, renamed, Vec<import_id>). We use `FxIndexMap` to keep the insert order.

`import_id` needs to be a `Vec` because we live in a dark world where you can have code like:

    mod raw {
        pub fn foo() {}
    }

    /// Foobar
    pub use raw::foo;

    pub use raw::*;

So in this case, we don’t want to have two items but just one with attributes from all non-glob imports to be merged. Glob imports attributes are always ignored, whether they’re shadowed or not.

§`inlined_foreigns: FxIndexMap<(DefId, Option<Symbol>), (Res, LocalDefId)>`

(def_id, renamed) -> (res, local_import_id)

`inlined_foreigns` only contains `extern` items that are cross-crate inlined.

Locally inlined `extern` items are stored in `foreigns` with the `import_id` set, analogous to how `items` is.

§`foreigns: Vec<(&'hir ForeignItem<'hir>, Option<Symbol>, Option<LocalDefId>)>`

(item, renamed, import_id)

## Implementations§

Source§

### impl Module<'_>

Source

#### pub(crate) fn new( name: Symbol, def_id: LocalDefId, where_inner: Span, renamed: Option<Symbol>, import_id: Option<LocalDefId>, ) -> Self

Source

#### pub(crate) fn where_outer(&self, tcx: TyCtxt<'_>) -> Span

## Trait Implementations§

Source§

### impl<'hir> Debug for Module<'hir>

Source§

#### fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

## Auto Trait Implementations§

§

### impl<'hir> Freeze for Module<'hir>

§

### impl<'hir> RefUnwindSafe for Module<'hir>

§

### impl<'hir> Send for Module<'hir>

§

### impl<'hir> Sync for Module<'hir>

§

### impl<'hir> Unpin for Module<'hir>

§

### impl<'hir> UnwindSafe for Module<'hir>

## Blanket Implementations§

§

### impl<T> Any for T
where T: 'static + ?Sized,

§

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more
§

### impl<T> Borrow<T> for T
where T: ?Sized,

§

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

### impl<T> BorrowMut<T> for T
where T: ?Sized,

§

#### fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

### impl<T> From<T> for T

§

#### fn from(t: T) -> T

Returns the argument unchanged.

§

### impl<T> Instrument for T

§

#### fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [`Span`], returning an `Instrumented` wrapper. Read more
§

#### fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current `Span`, returning an `Instrumented` wrapper. Read more
§

### impl<T, U> Into<U> for T
where U: From<T>,

§

#### fn into(self) -> U

Calls `U::from(self)`.

That is, this conversion is whatever the implementation of `From<T> for U` chooses to do.

§

### impl<T> IntoEither for T

§

#### fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts `self` into a `Left` variant of `Either<Self, Self>` if `into_left` is `true`. Converts `self` into a `Right` variant of `Either<Self, Self>` otherwise. Read more
§

#### fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts `self` into a `Left` variant of `Either<Self, Self>` if `into_left(&self)` returns `true`. Converts `self` into a `Right` variant of `Either<Self, Self>` otherwise. Read more
§

### impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

#### type Error = Infallible

The type returned in the event of a conversion error.
§

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
§

### impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

#### type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
§

#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

### impl<T> WithSubscriber for T

§

#### fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided `Subscriber` to this type, returning a [`WithDispatch`] wrapper. Read more
§

#### fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default `Subscriber` to this type, returning a [`WithDispatch`] wrapper. Read more

## Layout§

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain `repr(...)` attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 184 bytes