Struct SyntaxContext

pub struct SyntaxContext(/* private fields */);

A SyntaxContext represents a chain of macro expansions (represented by marks).

Implementations

impl SyntaxContext

pub const fn empty() -> Self

pub fn has_mark(self, mark: Mark) -> bool

Returns true if self is marked with mark.

Panics if mark is not a valid mark.

pub fn as_u32(self) -> u32

pub fn from_u32(raw: u32) -> SyntaxContext

pub fn apply_mark(self, mark: Mark) -> SyntaxContext

Extend a syntax context with a given mark and default transparency for that mark.

pub fn remove_mark(&mut self) -> Mark

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 adjust(&mut self, expansion: Mark) -> Option<Mark>

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 `Mark` from `m`.
        pub fn $f() {} // `$f`'s `SyntaxContext` is empty.
    }
    foo::f(); // `f`'s `SyntaxContext` has a single `Mark` 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 `Mark` 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 glob_adjust( &mut self, expansion: Mark, glob_ctxt: SyntaxContext, ) -> Option<Option<Mark>>

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 `Mark` 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, expansion: Mark, glob_ctxt: SyntaxContext, ) -> Option<Option<Mark>>

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 outer(self) -> Mark

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 Debug for SyntaxContext

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

Formats the value using the given formatter.

impl Default for SyntaxContext

fn default() -> SyntaxContext

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SyntaxContext

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl EqIgnoreSpan for SyntaxContext

fn eq_ignore_span(&self, other: &Self) -> bool

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, Self: Sized,

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.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for SyntaxContext

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd 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: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for SyntaxContext

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TypeEq for SyntaxContext

fn type_eq(&self, other: &Self) -> bool

Note: This method should return true for non-type values.

impl Copy for SyntaxContext

impl Eq for SyntaxContext

impl StructuralPartialEq for SyntaxContext