Struct artichoke_backend::extn::core::symbol::Symbol

pub struct Symbol(_);

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

#[must_use]pub const fn new(id: u32) -> Symbol

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

#[must_use]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);

#[must_use]pub fn is_empty<T, U>(self, interner: &T) -> bool where
    T: Intern<Symbol = U>,
    U: Copy + From<Symbol>, 

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.

#[must_use]pub fn len<T, U>(self, interner: &T) -> usize where
    T: Intern<Symbol = U>,
    U: Copy + From<Symbol>, 

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.

#[must_use]pub fn bytes<T, U>(self, interner: &T) -> &[u8] where
    T: Intern<Symbol = U>,
    U: Copy + From<Symbol>, 

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<'_> where
    T: Intern<Symbol = U>,
    U: Copy + From<Symbol>, 

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

If there 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

pub fn borrow(&self) -> &u32

Immutably borrows from an owned value.

impl BoxUnboxVmValue for Symbol

type Unboxed = Self

type Guarded = Immediate<Self::Unboxed>

const RUBY_TYPE: &'static str

unsafe fn unbox_from_value<'a>(
    value: &'a mut Value,
    interp: &mut Artichoke
) -> Result<UnboxedValueGuard<'a, Self::Guarded>, Error>

Safety

fn alloc_value(
    value: Self::Unboxed,
    interp: &mut Artichoke
) -> Result<Value, Error>

fn box_into_value(
    value: Self::Unboxed,
    into: Value,
    interp: &mut Artichoke
) -> Result<Value, Error>

fn free(data: *mut c_void)

impl Clone for Symbol

pub fn clone(&self) -> Symbol

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Symbol

impl Debug for Symbol

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

Formats the value using the given formatter.

impl Eq for Symbol

impl<'_> From<&'_ NonZeroU16> for Symbol

pub fn from(sym: &NonZeroU16) -> Symbol

Performs the conversion.

impl<'_> From<&'_ NonZeroU32> for Symbol

pub fn from(sym: &NonZeroU32) -> Symbol

Performs the conversion.

impl<'_> From<&'_ NonZeroU8> for Symbol

pub fn from(sym: &NonZeroU8) -> Symbol

Performs the conversion.

impl<'_> From<&'_ u16> for Symbol

pub fn from(id: &u16) -> Symbol

Performs the conversion.

impl<'_> From<&'_ u32> for Symbol

pub fn from(id: &u32) -> Symbol

Performs the conversion.

impl<'_> From<&'_ u8> for Symbol

pub fn from(id: &u8) -> Symbol

Performs the conversion.

impl From<NonZeroU16> for Symbol

pub fn from(sym: NonZeroU16) -> Symbol

Performs the conversion.

impl From<NonZeroU32> for Symbol

pub fn from(sym: NonZeroU32) -> Symbol

Performs the conversion.

impl From<NonZeroU8> for Symbol

pub fn from(sym: NonZeroU8) -> Symbol

Performs the conversion.

impl From<u16> for Symbol

pub fn from(id: u16) -> Symbol

Performs the conversion.

impl From<u32> for Symbol

pub fn from(id: u32) -> Symbol

Performs the conversion.

impl From<u8> for Symbol

pub fn from(id: u8) -> Symbol

Performs the conversion.

impl Hash for Symbol

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Ord for Symbol

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<'_> PartialEq<&'_ u32> for Symbol

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

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<Symbol> for Symbol

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

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

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

This method tests for !=.

impl<'_> PartialEq<u32> for &'_ Symbol

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

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<u32> for Symbol

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

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<Symbol> for Symbol

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

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl StructuralEq for Symbol

impl StructuralPartialEq for Symbol

impl<'_> TryFrom<&'_ NonZeroU64> for Symbol

type Error = SymbolOverflowError

The type returned in the event of a conversion error.

pub fn try_from(
    value: &NonZeroU64
) -> Result<Symbol, <Symbol as TryFrom<&'_ NonZeroU64>>::Error>

Performs the conversion.

impl<'_> TryFrom<&'_ NonZeroUsize> for Symbol

type Error = SymbolOverflowError

The type returned in the event of a conversion error.

pub fn try_from(
    value: &NonZeroUsize
) -> Result<Symbol, <Symbol as TryFrom<&'_ NonZeroUsize>>::Error>

Performs the conversion.

impl<'_> TryFrom<&'_ u64> for Symbol

type Error = SymbolOverflowError

The type returned in the event of a conversion error.

pub fn try_from(
    value: &u64
) -> Result<Symbol, <Symbol as TryFrom<&'_ u64>>::Error>

Performs the conversion.

impl<'_> TryFrom<&'_ usize> for Symbol

type Error = SymbolOverflowError

The type returned in the event of a conversion error.

pub fn try_from(
    value: &usize
) -> Result<Symbol, <Symbol as TryFrom<&'_ usize>>::Error>

Performs the conversion.

impl TryFrom<NonZeroU64> for Symbol

type Error = SymbolOverflowError

The type returned in the event of a conversion error.

pub fn try_from(
    value: NonZeroU64
) -> Result<Symbol, <Symbol as TryFrom<NonZeroU64>>::Error>

Performs the conversion.

impl TryFrom<NonZeroUsize> for Symbol

type Error = SymbolOverflowError

The type returned in the event of a conversion error.

pub fn try_from(
    value: NonZeroUsize
) -> Result<Symbol, <Symbol as TryFrom<NonZeroUsize>>::Error>

Performs the conversion.

impl TryFrom<u64> for Symbol

type Error = SymbolOverflowError

The type returned in the event of a conversion error.

pub fn try_from(value: u64) -> Result<Symbol, <Symbol as TryFrom<u64>>::Error>

Performs the conversion.

impl TryFrom<usize> for Symbol

type Error = SymbolOverflowError

The type returned in the event of a conversion error.

pub fn try_from(
    value: usize
) -> Result<Symbol, <Symbol as TryFrom<usize>>::Error>

Performs the conversion.