Skip to main content

Symbol

Struct Symbol 

Source
pub struct Symbol(/* private fields */);
Expand description

A interned string in the global symbol table.

This requires the global feature on the crate.

GlobalSymbol is a wrapper around Symbol that knows to refer to a built-in, global SymbolTable. Strings into the global table are never freed.

This enables a lot of convience methods and trait implementations over GlobalSymbol (see below). In particular, you can convert it to &'static str, convert From and Into a &str, and de/serialize using serde if the serde feature is enabled.

Implementations§

Source§

impl GlobalSymbol

Source

pub fn new(s: impl AsRef<str>) -> GlobalSymbol

Intern a string into the global symbol table.

Source

pub fn as_str(&self) -> &'static str

Convert this symbol into the string in the static, global symbol table.

Trait Implementations§

Source§

impl Clone for GlobalSymbol

Source§

fn clone(&self) -> GlobalSymbol

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for GlobalSymbol

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for GlobalSymbol

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<&String> for GlobalSymbol

Source§

fn from(s: &String) -> GlobalSymbol

Converts to this type from the input type.
Source§

impl From<&str> for GlobalSymbol

Source§

fn from(s: &str) -> GlobalSymbol

Converts to this type from the input type.
Source§

impl From<GlobalSymbol> for &'static str

Source§

fn from(sym: GlobalSymbol) -> &'static str

Converts to this type from the input type.
Source§

impl From<NonZero<u32>> for GlobalSymbol

Source§

fn from(n: NonZero<u32>) -> GlobalSymbol

Converts to this type from the input type.
Source§

impl From<String> for GlobalSymbol

Source§

fn from(s: String) -> GlobalSymbol

Converts to this type from the input type.
Source§

impl FromStr for GlobalSymbol

Source§

type Err = Infallible

The associated error which can be returned from parsing.
Source§

fn from_str(s: &str) -> Result<GlobalSymbol, <GlobalSymbol as FromStr>::Err>

Parses a string s to return a value of this type. Read more
Source§

impl Hash for GlobalSymbol

Source§

fn hash<__H>(&self, state: &mut __H)
where __H: Hasher,

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl LanguageChildren for Symbol

Source§

fn all_slot_occurrences_iter_mut(&mut self) -> impl Iterator<Item = &mut Slot>

Source§

fn public_slot_occurrences_iter_mut( &mut self, ) -> impl Iterator<Item = &mut Slot>

Source§

fn applied_id_occurrences_iter_mut( &mut self, ) -> impl Iterator<Item = &mut AppliedId>

Source§

fn all_slot_occurrences_iter(&self) -> impl Iterator<Item = &Slot>

Source§

fn public_slot_occurrences_iter(&self) -> impl Iterator<Item = &Slot>

Source§

fn applied_id_occurrences_iter(&self) -> impl Iterator<Item = &AppliedId>

Source§

fn to_syntax(&self) -> Vec<SyntaxElem>

Source§

fn from_syntax(elems: &[SyntaxElem]) -> Option<Self>

Source§

fn weak_shape_impl(&mut self, _m: &mut (SlotMap, u32))

Source§

impl Ord for GlobalSymbol

Source§

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

This method returns an Ordering between self and other. Read more
1.21.0 (const: unstable) · Source§

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

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

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

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · Source§

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

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for GlobalSymbol

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl PartialOrd for GlobalSymbol

Source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl Copy for GlobalSymbol

Source§

impl Eq for GlobalSymbol

Source§

impl StructuralPartialEq for GlobalSymbol

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CallHasher for T
where T: Hash + ?Sized,

Source§

default fn get_hash<H, B>(value: &H, build_hasher: &B) -> u64
where H: Hash + ?Sized, B: BuildHasher,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.