Struct Ident

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

An identifier.

Fields

name: Symbol

The identifier’s name.

span: Span

The identifier’s span.

Implementations

impl Ident

pub const DUMMY: Self

A dummy identifier.

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

Constructs a new identifier from a symbol and a span.

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

Constructs a new identifier with a dummy span.

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

Maps a string to an identifier with a dummy span.

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

Maps a string and a span to an identifier.

pub fn to_string(&self) -> String

“Specialization” of ToString using as_str.

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.

pub fn is_used_keyword(self) -> bool

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

pub fn is_unused_keyword(self) -> bool

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

pub fn is_weak_keyword(self) -> bool

Returns true if the identifier is a weak keyword and can be used in variable names.

pub fn is_yul_keyword(self) -> bool

Returns true if the identifier is a keyword in a Yul context.

pub fn is_yul_evm_builtin(self) -> bool

Returns true if the identifier is a Yul EVM builtin keyword.

pub fn is_reserved(self, yul: bool) -> bool

Returns true if the identifier is either a keyword, either currently in use or reserved for possible future use.

pub fn is_non_reserved(self, yul: bool) -> bool

Returns true if the identifier is not a reserved keyword. See is_reserved.

pub fn is_elementary_type(self) -> bool

Returns true if the identifier is an elementary type name.

Note that this does not include [u]fixedMxN types.

pub fn is_bool_lit(self) -> bool

Returns true if the identifier is true or false.

pub fn is_location_specifier(self) -> bool

Returns true if the identifier is a location specifier.

pub fn is_mutability_specifier(self) -> bool

Returns true if the identifier is a mutability specifier.

pub fn is_visibility_specifier(self) -> bool

Returns true if the identifier is a visibility specifier.

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

fn default() -> Self

Returns the “default value” for a type.

impl Display for Ident

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

Formats the value using the given formatter.

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

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

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

impl Eq for Ident