HygieneData in rustc_span::hygiene - Rust
Description: API documentation for the Rust `HygieneData` struct in crate `rustc_span`.

Skip to main content

## HygieneData

# Struct HygieneData

Source

    pub(crate) struct HygieneData {
        local_expn_data: IndexVec<LocalExpnId, Option<ExpnData>>,
        local_expn_hashes: IndexVec<LocalExpnId, ExpnHash>,
        foreign_expn_data: FxHashMap<ExpnId, ExpnData>,
        foreign_expn_hashes: FxHashMap<ExpnId, ExpnHash>,
        expn_hash_to_expn_id: UnhashMap<ExpnHash, ExpnId>,
        syntax_context_data: Vec<SyntaxContextData>,
        syntax_context_map: FxHashMap<SyntaxContextKey, SyntaxContext>,
        expn_data_disambiguators: UnhashMap<Hash64, u32>,
    }

## Fields§

§`local_expn_data: IndexVec<LocalExpnId, Option<ExpnData>>`

Each expansion should have an associated expansion data, but sometimes there’s a delay between creation of an expansion ID and obtaining its data (e.g. macros are collected first and then resolved later), so we use an `Option` here.

§`local_expn_hashes: IndexVec<LocalExpnId, ExpnHash>`§`foreign_expn_data: FxHashMap<ExpnId, ExpnData>`

Data and hash information from external crates. We may eventually want to remove these maps, and fetch the information directly from the other crate’s metadata like DefIds do.

§`foreign_expn_hashes: FxHashMap<ExpnId, ExpnHash>`§`expn_hash_to_expn_id: UnhashMap<ExpnHash, ExpnId>`§`syntax_context_data: Vec<SyntaxContextData>`§`syntax_context_map: FxHashMap<SyntaxContextKey, SyntaxContext>`§`expn_data_disambiguators: UnhashMap<Hash64, u32>`

Maps the `local_hash` of an `ExpnData` to the next disambiguator value. This is used by `update_disambiguator` to keep track of which `ExpnData`s would have collisions without a disambiguator. The keys of this map are always computed with `ExpnData.disambiguator` set to 0.

## Implementations§

Source§

### impl HygieneData

Source

#### pub(crate) fn new(edition: Edition) -> Self

Source

#### fn with<R>(f: impl FnOnce(&mut HygieneData) -> R) -> R

Source

#### fn expn_hash(&self, expn_id: ExpnId) -> ExpnHash

Source

#### fn local_expn_data(&self, expn_id: LocalExpnId) -> &ExpnData

Source

#### fn expn_data(&self, expn_id: ExpnId) -> &ExpnData

Source

#### fn is_descendant_of(&self, expn_id: ExpnId, ancestor: ExpnId) -> bool

Source

#### fn normalize_to_macros_2_0(&self, ctxt: SyntaxContext) -> SyntaxContext

Source

#### fn normalize_to_macro_rules(&self, ctxt: SyntaxContext) -> SyntaxContext

Source

#### fn outer_expn(&self, ctxt: SyntaxContext) -> ExpnId

See `SyntaxContextData::outer_expn`

Source

#### fn outer_mark(&self, ctxt: SyntaxContext) -> (ExpnId, Transparency)

The last macro expansion and its Transparency

Source

#### fn parent_ctxt(&self, ctxt: SyntaxContext) -> SyntaxContext

Source

#### fn remove_mark(&self, ctxt: &mut SyntaxContext) -> (ExpnId, Transparency)

Source

#### fn marks(&self, ctxt: SyntaxContext) -> Vec<(ExpnId, Transparency)>

Source

#### fn walk_chain(&self, span: Span, to: SyntaxContext) -> Span

Source

#### fn walk_chain_collapsed(&self, span: Span, to: Span) -> Span

Source

#### fn adjust(&self, ctxt: &mut SyntaxContext, expn_id: ExpnId) -> Option<ExpnId>

Source

#### fn apply_mark( &mut self, ctxt: SyntaxContext, expn_id: ExpnId, transparency: Transparency, ) -> SyntaxContext

Source

#### fn alloc_ctxt( &mut self, parent: SyntaxContext, expn_id: ExpnId, transparency: Transparency, ) -> SyntaxContext

Allocate a new context with the given key, or retrieve it from cache if the given key already exists. The auxiliary fields are calculated from the key.

## Trait Implementations§

Source§

### impl Debug for HygieneData

Source§

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

Formats the value using the given formatter. Read more

## Auto Trait Implementations§

§

### impl DynSend for HygieneData

§

### impl DynSync for HygieneData

§

### impl Freeze for HygieneData

§

### impl RefUnwindSafe for HygieneData

§

### impl Send for HygieneData

§

### impl Sync for HygieneData

§

### impl Unpin for HygieneData

§

### impl UnsafeUnpin for HygieneData

§

### impl UnwindSafe for HygieneData

## Blanket Implementations§

Source§

### impl<T> Aligned for T

Source§

#### const ALIGN: Alignment

Alignment of `Self`.
Source§

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

Source§

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

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

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

Source§

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

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

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

Returns the argument unchanged.

Source§

### impl<T> Instrument for T

Source§

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

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

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

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

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

Source§

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

Calls `U::from(self)`.

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

Source§

### impl<T> IntoEither for T

Source§

#### 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
Source§

#### 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
Source§

### impl<T> Pointable for T

Source§

#### const ALIGN: usize

The alignment of pointer.
Source§

#### type Init = T

The type for initializers.
Source§

#### unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

#### unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

#### unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

#### unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

### impl<T> Same for T

Source§

#### type Output = T

Should always be `Self`
Source§

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

Source§

#### type Error = Infallible

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

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

Performs the conversion.
Source§

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

Source§

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

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

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

Performs the conversion.
Source§

### impl<T> WithSubscriber for T

Source§

#### 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
Source§

#### 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: 232 bytes