Struct Symbol

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

Identifier bound to an interned string.

SymbolTable is guaranteed to return an equivalent Symbol each time an equivalent string is interned.

A Symbol allows retrieving a reference to the original interned string.

Symbols are based on a u32 index.

Symbols are not constrained to the SymbolTable which created them. No runtime checks ensure that SymbolTable::get is called with a Symbol that the table itself issued.

Implementations

impl Symbol

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

Construct a new Symbol from the given u32.

Symbols constructed outside a SymbolTable may fail to resolve to an underlying string using SymbolTable::get.

Symbols are not constrained to the SymbolTable which created them. No runtime checks ensure that SymbolTable::get is called with a Symbol that the table itself issued.

Examples

let sym = Symbol::new(263);
assert_eq!(263, sym.id());

pub const fn id(self) -> u32

Return the u32 identifier from this Symbol.

Examples

let mut table = SymbolTable::new();
let sym = table.intern("intaglio")?;
assert_eq!(u32::from(sym), sym.id());

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 From<&NonZero<u16>> for Symbol

fn from(sym: &NonZeroU16) -> Self

Converts to this type from the input type.

impl From<&NonZero<u32>> for Symbol

fn from(sym: &NonZeroU32) -> Self

Converts to this type from the input type.

impl From<&NonZero<u8>> for Symbol

fn from(sym: &NonZeroU8) -> Self

Converts to this type from the input type.

impl From<&Symbol> for i64

fn from(sym: &Symbol) -> Self

Converts to this type from the input type.

impl From<&Symbol> for u32

fn from(sym: &Symbol) -> Self

Converts to this type from the input type.

impl From<&Symbol> for u64

fn from(sym: &Symbol) -> Self

Converts to this type from the input type.

impl From<&Symbol> for usize

fn from(sym: &Symbol) -> Self

Converts to this type from the input type.

impl From<&u16> for Symbol

fn from(id: &u16) -> Self

Converts to this type from the input type.

impl From<&u32> for Symbol

fn from(id: &u32) -> Self

Converts to this type from the input type.

impl From<&u8> for Symbol

fn from(id: &u8) -> Self

Converts to this type from the input type.

impl From<NonZero<u16>> for Symbol

fn from(sym: NonZeroU16) -> Self

Converts to this type from the input type.

impl From<NonZero<u32>> for Symbol

fn from(sym: NonZeroU32) -> Self

Converts to this type from the input type.

impl From<NonZero<u8>> for Symbol

fn from(sym: NonZeroU8) -> Self

Converts to this type from the input type.

impl From<Symbol> for i64

fn from(sym: Symbol) -> Self

Converts to this type from the input type.

impl From<Symbol> for u32

fn from(sym: Symbol) -> Self

Converts to this type from the input type.

impl From<Symbol> for u64

fn from(sym: Symbol) -> Self

Converts to this type from the input type.

impl From<Symbol> for usize

fn from(sym: Symbol) -> Self

Converts to this type from the input type.

impl From<u16> for Symbol

fn from(id: u16) -> Self

Converts to this type from the input type.

impl From<u32> for Symbol

fn from(id: u32) -> Self

Converts to this type from the input type.

impl From<u8> for Symbol

fn from(id: u8) -> Self

Converts to this type from the input type.

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<&Symbol> for u32

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 PartialEq<&u32> for Symbol

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

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 PartialEq<Symbol> for u32

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 PartialEq<u32> for &Symbol

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

fn eq(&self, other: &u32) -> 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 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 TryFrom<&NonZero<u64>> for Symbol

type Error = SymbolOverflowError

The type returned in the event of a conversion error.

fn try_from(value: &NonZeroU64) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&NonZero<usize>> for Symbol

type Error = SymbolOverflowError

The type returned in the event of a conversion error.

fn try_from(value: &NonZeroUsize) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&u64> for Symbol

type Error = SymbolOverflowError

The type returned in the event of a conversion error.

fn try_from(value: &u64) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&usize> for Symbol

type Error = SymbolOverflowError

The type returned in the event of a conversion error.

fn try_from(value: &usize) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<NonZero<u64>> for Symbol

type Error = SymbolOverflowError

The type returned in the event of a conversion error.

fn try_from(value: NonZeroU64) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<NonZero<usize>> for Symbol

type Error = SymbolOverflowError

The type returned in the event of a conversion error.

fn try_from(value: NonZeroUsize) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<u64> for Symbol

type Error = SymbolOverflowError

The type returned in the event of a conversion error.

fn try_from(value: u64) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<usize> for Symbol

type Error = SymbolOverflowError

The type returned in the event of a conversion error.

fn try_from(value: usize) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for Symbol

impl Eq for Symbol

impl StructuralPartialEq for Symbol