Struct spinoso_symbol::Symbol

source ·
pub struct Symbol(_);
Expand description

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§

source§

impl Symbol

source

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

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

pub fn is_empty<T, U>(self, interner: &T) -> boolwhere
    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.

source

pub fn len<T, U>(self, interner: &T) -> usizewhere
    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.

source

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.

source

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§

source§

impl Borrow<u32> for Symbol

source§

fn borrow(&self) -> &u32

Immutably borrows from an owned value. Read more
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<&NonZeroU16> for Symbol

source§

fn from(sym: &NonZeroU16) -> Self

Converts to this type from the input type.
source§

impl From<&NonZeroU32> for Symbol

source§

fn from(sym: &NonZeroU32) -> Self

Converts to this type from the input type.
source§

impl From<&NonZeroU8> 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<NonZeroU16> for Symbol

source§

fn from(sym: NonZeroU16) -> Self

Converts to this type from the input type.
source§

impl From<NonZeroU32> for Symbol

source§

fn from(sym: NonZeroU32) -> Self

Converts to this type from the input type.
source§

impl From<NonZeroU8> 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) -> Selfwhere
    Self: Sized,

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

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

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

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

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 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 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 PartialOrd<Symbol> 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<&NonZeroU64> 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<&NonZeroUsize> 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<NonZeroU64> 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<NonZeroUsize> 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 StructuralEq for Symbol

source§

impl StructuralPartialEq for Symbol

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

const: unstable · source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

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

const: unstable · 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 Twhere
    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 Twhere
    U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

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

Performs the conversion.
source§

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

§

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

The type returned in the event of a conversion error.
const: unstable · source§

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

Performs the conversion.