Struct rustc_span::hygiene::LocalExpnId

pub struct LocalExpnId {
    private: u32,
}

A unique ID associated with a macro invocation and expansion.

Fields

private: u32

Implementations

impl LocalExpnId

pub const MAX_AS_U32: u32

Maximum value the index can take, as a u32.

pub const MAX: Self

Maximum value the index can take.

pub const fn from_usize(value: usize) -> Self

Creates a new index from a given usize.

Panics

Will panic if value exceeds MAX.

pub const fn from_u32(value: u32) -> Self

Creates a new index from a given u32.

Panics

Will panic if value exceeds MAX.

pub const unsafe fn from_u32_unchecked(value: u32) -> Self

Creates a new index from a given u32.

Safety

The provided value must be less than or equal to the maximum value for the newtype. Providing a value outside this range is undefined due to layout restrictions.

Prefer using from_u32.

pub const fn index(self) -> usize

Extracts the value of this index as a usize.

pub const fn as_u32(self) -> u32

Extracts the value of this index as a u32.

pub const fn as_usize(self) -> usize

Extracts the value of this index as a usize.

impl LocalExpnId

pub const ROOT: LocalExpnId

The ID of the theoretical expansion that generates freshly parsed, unexpanded AST.

pub fn from_raw(idx: ExpnIndex) -> LocalExpnId

pub fn as_raw(self) -> ExpnIndex

pub fn fresh_empty() -> LocalExpnId

pub fn fresh(expn_data: ExpnData, ctx: impl HashStableContext) -> LocalExpnId

pub fn expn_hash(self) -> ExpnHash

pub fn expn_data(self) -> ExpnData

pub fn to_expn_id(self) -> ExpnId

pub fn set_expn_data(self, expn_data: ExpnData, ctx: impl HashStableContext)

pub fn is_descendant_of(self, ancestor: LocalExpnId) -> bool

pub fn outer_expn_is_descendant_of(self, ctxt: SyntaxContext) -> bool

expn_id.outer_expn_is_descendant_of(ctxt) is equivalent to but faster than expn_id.is_descendant_of(ctxt.outer_expn()).

pub fn expansion_cause(self) -> Option<Span>

Returns span for the macro which originally caused this expansion to happen.

Stops backtracing at include! boundary.

pub fn parent(self) -> LocalExpnId

Trait Implementations

impl Add<usize> for LocalExpnId

type Output = Self

The resulting type after applying the + operator.

fn add(self, other: usize) -> Self

Performs the + operation.

impl Clone for LocalExpnId

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LocalExpnId

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

Formats the value using the given formatter.

impl<D: Decoder> Decodable<D> for LocalExpnId

fn decode(d: &mut D) -> Self

impl<E: Encoder> Encodable<E> for LocalExpnId

fn encode(&self, e: &mut E) -> Result<(), E::Error>

impl From<LocalExpnId> for u32

fn from(v: LocalExpnId) -> u32

Performs the conversion.

impl From<LocalExpnId> for usize

fn from(v: LocalExpnId) -> usize

Performs the conversion.

impl From<u32> for LocalExpnId

fn from(value: u32) -> Self

Performs the conversion.

impl From<usize> for LocalExpnId

fn from(value: usize) -> Self

Performs the conversion.

impl Hash for LocalExpnId

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 Idx for LocalExpnId

fn new(value: usize) -> Self

fn index(self) -> usize

fn increment_by(&mut self, amount: usize)

fn plus(self, amount: usize) -> Self

impl Ord for LocalExpnId

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<LocalExpnId> for LocalExpnId

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

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

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

This method tests for !=.

impl PartialOrd<LocalExpnId> for LocalExpnId

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

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

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

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

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

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

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

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

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

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

impl Step for LocalExpnId

fn steps_between(start: &Self, end: &Self) -> Option<usize>

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

Returns the number of successor steps required to get from start to end.

fn forward_checked(start: Self, u: usize) -> Option<Self>

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

Returns the value that would be obtained by taking the successor of self count times.

fn backward_checked(start: Self, u: usize) -> Option<Self>

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

Returns the value that would be obtained by taking the predecessor of self count times.

fn forward(start: Self, count: usize) -> Self

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

Returns the value that would be obtained by taking the successor of self count times.

unsafe fn forward_unchecked(start: Self, count: usize) -> Self

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

Returns the value that would be obtained by taking the successor of self count times.

fn backward(start: Self, count: usize) -> Self

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

Returns the value that would be obtained by taking the predecessor of self count times.

unsafe fn backward_unchecked(start: Self, count: usize) -> Self

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

Returns the value that would be obtained by taking the predecessor of self count times.

impl Copy for LocalExpnId

impl Eq for LocalExpnId

impl StructuralEq for LocalExpnId

impl StructuralPartialEq for LocalExpnId

impl TrustedStep for LocalExpnId

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: 4 bytes