Struct Symbol 

pub struct Symbol(NonZeroU32);

An interned string.

Represented as an index internally, with all operations based on that. A Symbol reserves the value 0, so that Option<Symbol> only takes up 4 bytes.

Tuple Fields

0: NonZeroU32

Implementations

impl Symbol

pub const fn new(index: u32) -> Self

Returns the corresponding Symbol for the given index.

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

Maps a string to its interned representation.

pub fn as_str<R>(self, s: &SessionGlobals, with: impl FnOnce(&str) -> R) -> R

Convert to effectively a &'static str given the SessionGlobals.

pub const fn as_u32(self) -> u32

Converts this symbol to the raw index.

fn serde_to_symbol<'de, D: Deserializer<'de>>( de: D, ) -> Result<NonZeroU32, D::Error>

fn serde_from_symbol<S: Serializer>( index: &NonZeroU32, ser: S, ) -> Result<S::Ok, S::Error>

Trait Implementations

impl Clone for Symbol

fn clone(&self) -> Symbol

Returns a duplicate 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<'de> Deserialize<'de> for Symbol

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Symbol

impl Eq for Symbol

impl StructuralPartialEq for Symbol