[][src]Struct rustc_span::hygiene::SyntaxContext

pub struct SyntaxContext(u32);

A SyntaxContext represents a chain of pairs (ExpnId, Transparency) named "marks".

Implementations

impl SyntaxContext[src]

pub const fn root() -> Self[src]

pub(crate) fn as_u32(self) -> u32[src]

pub(crate) fn from_u32(raw: u32) -> SyntaxContext[src]

pub(crate) fn apply_mark(
    self,
    expn_id: ExpnId,
    transparency: Transparency
) -> SyntaxContext
[src]

Extend a syntax context with a given expansion and transparency.

pub fn remove_mark(&mut self) -> ExpnId[src]

Pulls a single mark off of the syntax context. This effectively moves the context up one macro definition level. That is, if we have a nested macro definition as follows:

macro_rules! f {
   macro_rules! g {
       ...
   }
}

and we have a SyntaxContext that is referring to something declared by an invocation of g (call it g1), calling remove_mark will result in the SyntaxContext for the invocation of f that created g1. Returns the mark that was removed.

pub fn marks(self) -> Vec<(ExpnId, Transparency)>[src]

pub fn adjust(&mut self, expn_id: ExpnId) -> Option<ExpnId>[src]

Adjust this context for resolution in a scope created by the given expansion. For example, consider the following three resolutions of f:

mod foo { pub fn f() {} } // `f`'s `SyntaxContext` is empty.
m!(f);
macro m($f:ident) {
    mod bar {
        pub fn f() {} // `f`'s `SyntaxContext` has a single `ExpnId` from `m`.
        pub fn $f() {} // `$f`'s `SyntaxContext` is empty.
    }
    foo::f(); // `f`'s `SyntaxContext` has a single `ExpnId` from `m`
    //^ Since `mod foo` is outside this expansion, `adjust` removes the mark from `f`,
    //| and it resolves to `::foo::f`.
    bar::f(); // `f`'s `SyntaxContext` has a single `ExpnId` from `m`
    //^ Since `mod bar` not outside this expansion, `adjust` does not change `f`,
    //| and it resolves to `::bar::f`.
    bar::$f(); // `f`'s `SyntaxContext` is empty.
    //^ Since `mod bar` is not outside this expansion, `adjust` does not change `$f`,
    //| and it resolves to `::bar::$f`.
}

This returns the expansion whose definition scope we use to privacy check the resolution, or None if we privacy check as usual (i.e., not w.r.t. a macro definition scope).

pub fn normalize_to_macros_2_0_and_adjust(
    &mut self,
    expn_id: ExpnId
) -> Option<ExpnId>
[src]

Like SyntaxContext::adjust, but also normalizes self to macros 2.0.

pub fn glob_adjust(
    &mut self,
    expn_id: ExpnId,
    glob_span: Span
) -> Option<Option<ExpnId>>
[src]

Adjust this context for resolution in a scope created by the given expansion via a glob import with the given SyntaxContext. For example:

m!(f);
macro m($i:ident) {
    mod foo {
        pub fn f() {} // `f`'s `SyntaxContext` has a single `ExpnId` from `m`.
        pub fn $i() {} // `$i`'s `SyntaxContext` is empty.
    }
    n(f);
    macro n($j:ident) {
        use foo::*;
        f(); // `f`'s `SyntaxContext` has a mark from `m` and a mark from `n`
        //^ `glob_adjust` removes the mark from `n`, so this resolves to `foo::f`.
        $i(); // `$i`'s `SyntaxContext` has a mark from `n`
        //^ `glob_adjust` removes the mark from `n`, so this resolves to `foo::$i`.
        $j(); // `$j`'s `SyntaxContext` has a mark from `m`
        //^ This cannot be glob-adjusted, so this is a resolution error.
    }
}

This returns None if the context cannot be glob-adjusted. Otherwise, it returns the scope to use when privacy checking (see adjust for details).

pub fn reverse_glob_adjust(
    &mut self,
    expn_id: ExpnId,
    glob_span: Span
) -> Option<Option<ExpnId>>
[src]

Undo glob_adjust if possible:

if let Some(privacy_checking_scope) = self.reverse_glob_adjust(expansion, glob_ctxt) {
    assert!(self.glob_adjust(expansion, glob_ctxt) == Some(privacy_checking_scope));
}

pub fn hygienic_eq(self, other: SyntaxContext, expn_id: ExpnId) -> bool[src]

pub fn normalize_to_macros_2_0(self) -> SyntaxContext[src]

pub fn normalize_to_macro_rules(self) -> SyntaxContext[src]

pub fn outer_expn(self) -> ExpnId[src]

pub fn outer_expn_data(self) -> ExpnData[src]

ctxt.outer_expn_data() is equivalent to but faster than ctxt.outer_expn().expn_data().

pub fn outer_mark(self) -> (ExpnId, Transparency)[src]

pub fn dollar_crate_name(self) -> Symbol[src]

Trait Implementations

impl Clone for SyntaxContext[src]

impl Copy for SyntaxContext[src]

impl Debug for SyntaxContext[src]

impl<D: Decoder> Decodable<D> for SyntaxContext[src]

impl<E: Encoder> Encodable<E> for SyntaxContext[src]

impl Eq for SyntaxContext[src]

impl Hash for SyntaxContext[src]

impl<CTX: HashStableContext> HashStable<CTX> for SyntaxContext[src]

impl Ord for SyntaxContext[src]

impl PartialEq<SyntaxContext> for SyntaxContext[src]

impl PartialOrd<SyntaxContext> for SyntaxContext[src]

impl StructuralEq for SyntaxContext[src]

impl StructuralPartialEq for SyntaxContext[src]

Auto Trait Implementations

impl RefUnwindSafe for SyntaxContext

impl Send for SyntaxContext

impl Sync for SyntaxContext

impl Unpin for SyntaxContext

impl UnwindSafe for SyntaxContext

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.