Struct intaglio::Symbol

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

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§

source§

impl Symbol

source

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());
source

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§

source§

impl Clone for Symbol

source§

fn clone(&self) -> Symbol

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Symbol

source§

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

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

impl From<&NonZero<u16>> for Symbol

source§

fn from(sym: &NonZeroU16) -> Self

Converts to this type from the input type.
source§

impl From<&NonZero<u32>> for Symbol

source§

fn from(sym: &NonZeroU32) -> Self

Converts to this type from the input type.
source§

impl From<&NonZero<u8>> for Symbol

source§

fn from(sym: &NonZeroU8) -> Self

Converts to this type from the input type.
source§

impl From<&Symbol> for i64

source§

fn from(sym: &Symbol) -> Self

Converts to this type from the input type.
source§

impl From<&Symbol> for u32

source§

fn from(sym: &Symbol) -> Self

Converts to this type from the input type.
source§

impl From<&Symbol> for u64

source§

fn from(sym: &Symbol) -> Self

Converts to this type from the input type.
source§

impl From<&Symbol> for usize

source§

fn from(sym: &Symbol) -> Self

Converts to this type from the input type.
source§

impl From<&u16> for Symbol

source§

fn from(id: &u16) -> Self

Converts to this type from the input type.
source§

impl From<&u32> for Symbol

source§

fn from(id: &u32) -> Self

Converts to this type from the input type.
source§

impl From<&u8> for Symbol

source§

fn from(id: &u8) -> Self

Converts to this type from the input type.
source§

impl From<NonZero<u16>> for Symbol

source§

fn from(sym: NonZeroU16) -> Self

Converts to this type from the input type.
source§

impl From<NonZero<u32>> for Symbol

source§

fn from(sym: NonZeroU32) -> Self

Converts to this type from the input type.
source§

impl From<NonZero<u8>> for Symbol

source§

fn from(sym: NonZeroU8) -> Self

Converts to this type from the input type.
source§

impl From<Symbol> for i64

source§

fn from(sym: Symbol) -> Self

Converts to this type from the input type.
source§

impl From<Symbol> for u32

source§

fn from(sym: Symbol) -> Self

Converts to this type from the input type.
source§

impl From<Symbol> for u64

source§

fn from(sym: Symbol) -> Self

Converts to this type from the input type.
source§

impl From<Symbol> for usize

source§

fn from(sym: Symbol) -> Self

Converts to this type from the input type.
source§

impl From<u16> for Symbol

source§

fn from(id: u16) -> Self

Converts to this type from the input type.
source§

impl From<u32> for Symbol

source§

fn from(id: u32) -> Self

Converts to this type from the input type.
source§

impl From<u8> for Symbol

source§

fn from(id: u8) -> Self

Converts to this type from the input type.
source§

impl Hash for Symbol

source§

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

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

source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · source§

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

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

impl PartialEq<&Symbol> for u32

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialEq<&u32> for Symbol

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialEq<Symbol> for &u32

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialEq<Symbol> for u32

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialEq<u32> for &Symbol

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialEq<u32> for Symbol

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialEq for Symbol

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialOrd for Symbol

source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
source§

impl TryFrom<&NonZero<u64>> for Symbol

§

type Error = SymbolOverflowError

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

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

Performs the conversion.
source§

impl TryFrom<&NonZero<usize>> for Symbol

§

type Error = SymbolOverflowError

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

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

Performs the conversion.
source§

impl TryFrom<&u64> for Symbol

§

type Error = SymbolOverflowError

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

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

Performs the conversion.
source§

impl TryFrom<&usize> for Symbol

§

type Error = SymbolOverflowError

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

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

Performs the conversion.
source§

impl TryFrom<NonZero<u64>> for Symbol

§

type Error = SymbolOverflowError

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

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

Performs the conversion.
source§

impl TryFrom<NonZero<usize>> for Symbol

§

type Error = SymbolOverflowError

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

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

Performs the conversion.
source§

impl TryFrom<u64> for Symbol

§

type Error = SymbolOverflowError

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

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

Performs the conversion.
source§

impl TryFrom<usize> for Symbol

§

type Error = SymbolOverflowError

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

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

Performs the conversion.
source§

impl Copy for Symbol

source§

impl Eq for Symbol

source§

impl StructuralPartialEq for Symbol

Auto Trait Implementations§

§

impl Freeze for Symbol

§

impl RefUnwindSafe for Symbol

§

impl Send for Symbol

§

impl Sync for Symbol

§

impl Unpin for Symbol

§

impl UnwindSafe for Symbol

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> 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,

§

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, U> TryFrom<U> for T
where U: Into<T>,

§

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>,

§

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.