Struct Symbol

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

An interned string.

Internally, a Symbol is implemented as an index, and all operations (including hashing, equality, and ordering) operate on that index.

Implementations

impl Symbol

pub const DUMMY: Self = kw::Empty

A dummy symbol.

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

Maps a string to its interned representation.

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. It’s not the same as &self, but actually tied to the lifetime of the underlying interner. Interners are long-lived, and there are very few of them, and this function is typically used for short-lived things, so in practice it works out ok.

pub const fn as_u32(self) -> u32

Returns the internal representation of the symbol.

pub fn is_used_keyword(self) -> bool

Returns true if the symbol is a keyword used in the Solidity language.

For Yul keywords, use is_yul_keyword.

pub fn is_unused_keyword(self) -> bool

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

pub fn is_weak_keyword(self) -> bool

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

pub fn is_yul_keyword(self) -> bool

Returns true if the symbol is a keyword in a Yul context. Excludes EVM builtins.

pub fn is_yul_builtin(self) -> bool

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

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

Returns true if the symbol 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 symbol is not a reserved keyword. See is_reserved.

pub fn is_elementary_type(self) -> bool

Returns true if the symbol is an elementary type name.

Note that this does not include [u]fixedMxN types as they are not pre-interned.

pub fn is_bool_lit(self) -> bool

Returns true if the symbol is true or false.

pub fn is_location_specifier(self) -> bool

Returns true if the symbol is a location specifier.

pub fn is_mutability_specifier(self) -> bool

Returns true if the symbol is a mutability specifier.

pub fn is_visibility_specifier(self) -> bool

Returns true if the symbol is a visibility specifier.

pub const fn is_preinterned(self) -> bool

Returns true if the symbol was interned in the compiler’s symbols! macro.

Trait Implementations

impl Clone for Symbol

fn clone(&self) -> Symbol

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Symbol

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

Formats the value using the given formatter.

impl Default for Symbol

fn default() -> Self

Returns the “default value” for a type.

impl Display for Symbol

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

Formats the value using the given formatter.

impl Hash for Symbol

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 Key for Symbol

fn into_usize(self) -> usize

Returns the usize that represents the current key

fn try_from_usize(value: usize) -> Option<Self>

Attempts to create a key from a usize, returning None if it fails

impl Ord for Symbol

fn cmp(&self, other: &Symbol) -> 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 Symbol

fn eq(&self, other: &Symbol) -> 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 Symbol

fn partial_cmp(&self, other: &Symbol) -> 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 Symbol

impl Eq for Symbol

impl StructuralPartialEq for Symbol