Struct Symbol

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

Identifier bound to an interned byte string.

A Symbol allows retrieving a reference to the original interned byte string. Equivalent Symbols will resolve to an identical byte string.

Symbols are based on a u32 index. They are cheap to compare and cheap to copy.

Symbols are not constrained to the interner which created them.

Implementations

impl Symbol

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

Construct a new Symbol from the given u32.

Symbols constructed manually may fail to resolve to an underlying byte string.

Symbols are not constrained to the interner which created them. No runtime checks ensure that the underlying interner is called with a Symbol that the interner itself issued.

Examples

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

pub const fn id(self) -> u32

Return the u32 identifier from this Symbol.

Examples

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

pub fn is_empty<T, U>(self, interner: &T) -> bool

where T: Intern<Symbol = U>, U: Copy + From<Symbol>,

Available on crate feature artichoke only.

Returns whether the symbol is the empty byte slice b"" in the underlying interner.

If there symbol does not exist in the underlying interner or there is an error looking up the symbol in the underlying interner, true is returned.

pub fn len<T, U>(self, interner: &T) -> usize

where T: Intern<Symbol = U>, U: Copy + From<Symbol>,

Available on crate feature artichoke only.

Returns the length of the byte slice associated with the symbol in the underlying interner.

If there symbol does not exist in the underlying interner or there is an error looking up the symbol in the underlying interner, 0 is returned.

pub fn bytes<T, U>(self, interner: &T) -> &[u8]

where T: Intern<Symbol = U>, U: Copy + From<Symbol>,

Available on crate feature artichoke only.

Returns the interned byte slice associated with the symbol in the underlying interner.

If there symbol does not exist in the underlying interner or there is an error looking up the symbol in the underlying interner, &[] is returned.

pub fn inspect<T, U>(self, interner: &T) -> Inspect<'_>

where T: Intern<Symbol = U>, U: Copy + From<Symbol>,

Available on crate feature artichoke only.

Returns an iterator that yields a debug representation of the interned byte slice associated with the symbol in the underlying interner.

This iterator produces char sequences like :spinoso and :"invalid-\xFF-utf8".

This function can be used to implement the Ruby method Symbol#inspect.

If the symbol does not exist in the underlying interner or there is an error looking up the symbol in the underlying interner, a default iterator is returned.

Trait Implementations

impl Clone for Symbol

fn clone(&self) -> Symbol

Returns a duplicate of the value.

const 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