Struct spinoso_symbol::Symbol[−][src]

pub struct Symbol(_);

Expand description

Identifier bound to an interned bytestring.

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

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 bytesstring.

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

This is supported on crate feature artichoke only.

Returns whether the symbol is the empty byteslice 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>,

This is supported on crate feature artichoke only.

Returns the length of the byteslice 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>,

This is supported on crate feature artichoke only.

Returns the interned byteslice 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<'_>ⓘ
Notable traits for Inspect<'a>
`impl<'a> Iterator for Inspect<'a> type Item = char;`
where
T: Intern<Symbol = U>,
U: Copy + From<Symbol>,

This is supported on crate feature artichoke only.

Returns an iterator that yields a debug representation of the interned byteslice 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 Borrow<u32> for Symbol

fn borrow(&self) -> &u32

Immutably borrows from an owned value. Read more

impl Clone for Symbol

fn clone(&self) -> Symbol

Returns a copy of the value. Read more

1.0.0[src]

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

Performs copy-assignment from source. Read more

impl Debug for Symbol

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

Formats the value using the given formatter. Read more

impl From<&'_ NonZeroU16> for Symbol

fn from(sym: &NonZeroU16) -> Self

Performs the conversion.

impl From<&'_ NonZeroU32> for Symbol

fn from(sym: &NonZeroU32) -> Self

Performs the conversion.

impl From<&'_ NonZeroU8> for Symbol

fn from(sym: &NonZeroU8) -> Self

Performs the conversion.

impl From<&'_ Symbol> for u32

fn from(sym: &Symbol) -> Self

Performs the conversion.

impl From<&'_ Symbol> for u64

fn from(sym: &Symbol) -> Self

Performs the conversion.

impl From<&'_ Symbol> for usize

fn from(sym: &Symbol) -> Self

Performs the conversion.

impl From<&'_ Symbol> for i64

fn from(sym: &Symbol) -> Self

Performs the conversion.

impl From<&'_ u16> for Symbol

fn from(id: &u16) -> Self

Performs the conversion.

impl From<&'_ u32> for Symbol

fn from(id: &u32) -> Self

Performs the conversion.

impl From<&'_ u8> for Symbol

fn from(id: &u8) -> Self

Performs the conversion.

impl From<NonZeroU16> for Symbol

fn from(sym: NonZeroU16) -> Self

Performs the conversion.

impl From<NonZeroU32> for Symbol

fn from(sym: NonZeroU32) -> Self

Performs the conversion.

impl From<NonZeroU8> for Symbol

fn from(sym: NonZeroU8) -> Self

Performs the conversion.

impl From<Symbol> for u32

fn from(sym: Symbol) -> Self

Performs the conversion.

impl From<Symbol> for u64

fn from(sym: Symbol) -> Self

Performs the conversion.

impl From<Symbol> for usize

fn from(sym: Symbol) -> Self

Performs the conversion.

impl From<Symbol> for i64

fn from(sym: Symbol) -> Self

Performs the conversion.

impl From<u16> for Symbol

fn from(id: u16) -> Self

Performs the conversion.

impl From<u32> for Symbol

fn from(id: u32) -> Self

Performs the conversion.

impl From<u8> for Symbol

fn from(id: u8) -> Self

Performs the conversion.

impl Hash for Symbol

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

Feeds this value into the given Hasher. Read more

1.3.0[src]

fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,

Feeds a slice of this type into the given Hasher. Read more

impl Ord for Symbol

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

This method returns an Ordering between self and other. Read more

1.21.0[src]

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

Compares and returns the maximum of two values. Read more

1.21.0[src]

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

Compares and returns the minimum of two values. Read more

1.50.0[src]

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval. Read more

impl PartialEq<&'_ Symbol> for u32

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

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0[src]

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

This method tests for !=.

impl PartialEq<&'_ u32> for Symbol

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

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0[src]

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

This method tests for !=.

impl PartialEq<Symbol> for u32

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

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0[src]

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

This method tests for !=.

impl PartialEq<Symbol> for &u32

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

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0[src]

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

This method tests for !=.

impl PartialEq<Symbol> for Symbol

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

This method tests for self and other values to be equal, and is used by ==. Read more

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

This method tests for !=.

impl PartialEq<u32> for Symbol

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

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0[src]

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

This method tests for !=.

impl PartialEq<u32> for &Symbol

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

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0[src]

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

This method tests for !=.

impl PartialOrd<Symbol> for Symbol

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[src]

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[src]

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[src]

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[src]

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

impl TryFrom<&'_ NonZeroU64> 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<&'_ NonZeroUsize> 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<NonZeroU64> 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<NonZeroUsize> 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 StructuralEq for Symbol

impl StructuralPartialEq for Symbol

Auto Trait Implementations

impl RefUnwindSafe for Symbol

impl Send for Symbol

impl Sync for Symbol

impl Unpin for Symbol

impl UnwindSafe for Symbol

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

pub fn from(t: T) -> T

Performs the conversion.

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

pub fn into(self) -> U

Performs the conversion.

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

pub fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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.

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

Performs the conversion.