Struct rustc_ap_rustc_span::hygiene::SyntaxContext

pub struct SyntaxContext(_);

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

Methods

impl SyntaxContext

pub const fn root() -> Self

pub fn remove_mark(&mut self) -> ExpnId

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)>

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

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 modernize_and_adjust(&mut self, expn_id: ExpnId) -> Option<ExpnId>

Like SyntaxContext::adjust, but also modernizes self.

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

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>>

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

pub fn modern(self) -> SyntaxContext

pub fn modern_and_legacy(self) -> SyntaxContext

pub fn outer_expn(self) -> ExpnId

pub fn outer_expn_data(self) -> ExpnData

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

pub fn outer_mark_with_data(self) -> (ExpnId, Transparency, ExpnData)

pub fn dollar_crate_name(self) -> Symbol

Trait Implementations

impl Clone for SyntaxContext

fn clone(&self) -> SyntaxContext

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for SyntaxContext

impl Debug for SyntaxContext

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Eq for SyntaxContext

impl Hash for SyntaxContext

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl Ord for SyntaxContext

fn cmp(&self, other: &SyntaxContext) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use] fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use] fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use] fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<SyntaxContext> for SyntaxContext

fn eq(&self, other: &SyntaxContext) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &SyntaxContext) -> bool

This method tests for !=.

impl PartialOrd<SyntaxContext> for SyntaxContext

fn partial_cmp(&self, other: &SyntaxContext) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &SyntaxContext) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &SyntaxContext) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &SyntaxContext) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &SyntaxContext) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for SyntaxContext

impl StructuralPartialEq for SyntaxContext