Struct Ident

pub struct Ident {
    pub name: Symbol,
    pub span: Span,
}

Fields

name: Symbol

span: Span

Implementations

impl Ident

pub const fn new(name: Symbol, span: Span) -> Ident

Constructs a new identifier from a symbol and a span.

pub const fn with_dummy_span(name: Symbol) -> Ident

Constructs a new identifier with a dummy span.

pub fn empty() -> Ident

pub fn from_str(string: &str) -> Ident

Maps a string to an identifier with a dummy span.

pub fn from_str_and_span(string: &str, span: Span) -> Ident

Maps a string and a span to an identifier.

pub fn with_span_pos(self, span: Span) -> Ident

Replaces lo and hi with those from span, but keep hygiene context.

pub fn without_first_quote(self) -> Ident

pub fn normalize_to_macros_2_0(self) -> Ident

“Normalize” ident for use in comparisons using “item hygiene”. Identifiers with same string value become same if they came from the same macro 2.0 macro (e.g., macro item, but not macro_rules item) and stay different if they came from different macro 2.0 macros. Technically, this operation strips all non-opaque marks from ident’s syntactic context.

pub fn normalize_to_macro_rules(self) -> Ident

“Normalize” ident for use in comparisons using “local variable hygiene”. Identifiers with same string value become same if they came from the same non-transparent macro (e.g., macro or macro_rules! items) and stay different if they came from different non-transparent macros. Technically, this operation strips all transparent marks from ident’s syntactic context.

pub fn as_str(&self) -> &str

Access the underlying string. This is a slowish operation because it requires locking the symbol interner.

Note that the lifetime of the return value is a lie. See Symbol::as_str() for details.

impl Ident

pub fn is_any_keyword(self) -> bool

Don’t use this unless you’re doing something very loose and heuristic-y.

pub fn is_special(self) -> bool

Returns true for reserved identifiers used internally for elided lifetimes, unnamed method parameters, crate root module, error recovery etc.

pub fn is_used_keyword(self) -> bool

Returns true if the token is a keyword used in the language.

pub fn is_unused_keyword(self) -> bool

Returns true if the token is a keyword reserved for possible future use.

pub fn is_reserved(self) -> bool

Returns true if the token is either a special identifier or a keyword.

pub fn is_path_segment_keyword(self) -> bool

A keyword or reserved identifier that can be used as a path segment.

pub fn is_raw_guess(self) -> bool

We see this identifier in a normal identifier position, like variable name or a type. How was it written originally? Did it use the raw form? Let’s try to guess.

Trait Implementations

impl Clone for Ident

fn clone(&self) -> Ident

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Ident

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

Formats the value using the given formatter.

impl<__D: SpanDecoder> Decodable<__D> for Ident

fn decode(__decoder: &mut __D) -> Self

impl Display for Ident

This implementation is supposed to be used in error messages, so it’s expected to be identical to printing the original identifier token written in source code (token_to_string), except that AST identifiers don’t keep the rawness flag, so we have to guess it.

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

Formats the value using the given formatter.

impl<__E: SpanEncoder> Encodable<__E> for Ident

fn encode(&self, __encoder: &mut __E)

impl Hash for Ident

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<__CTX> HashStable<__CTX> for Ident

where __CTX: HashStableContext,

fn hash_stable(&self, __hcx: &mut __CTX, __hasher: &mut StableHasher)

impl PartialEq for Ident

fn eq(&self, rhs: &Self) -> 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 Copy for Ident

impl Eq for Ident

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