Struct spinoso_symbol::Symbol

source ·

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

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

source

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.

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