Struct syntax_pos::symbol::Ident

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

Fields

name: Symbol

span: Span

Methods

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 invalid() -> Ident

pub fn from_interned_str(string: InternedString) -> Ident

Maps an interned string to an identifier with an empty syntax context.

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

Maps a string to an identifier with an empty 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 modern(self) -> Ident

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

pub fn modern_and_legacy(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 gensym(self) -> Ident

Transforms an identifier into one with the same name, but gensymed.

pub fn gensym_if_underscore(self) -> Ident

Transforms an underscore identifier into one with the same name, but gensymed. Leaves non-underscore identifiers unchanged.

pub fn is_gensymed(self) -> bool

pub fn as_str(self) -> LocalInternedString

pub fn as_interned_str(self) -> InternedString

impl Ident

pub fn is_special(self) -> bool

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 Copy for Ident

impl Eq for Ident

impl PartialEq<Ident> for Ident

fn eq(&self, rhs: &Self) -> bool

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

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, 

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

impl Display for Ident

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

Formats the value using the given formatter.

impl Debug for Ident

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

Formats the value using the given formatter.

impl UseSpecializedEncodable for Ident

fn default_encode<E>(&self, &mut E) -> Result<(), <E as Encoder>::Error> where
    E: Encoder, 

Defaults to returning an error (see SpecializationError).

impl UseSpecializedDecodable for Ident

fn default_decode<D>(&mut D) -> Result<Self, <D as Decoder>::Error> where
    D: Decoder, 

Defaults to returning an error (see SpecializationError).