Struct Symbol

pub struct Symbol<'a, T: 'a> { /* private fields */ }

A symbol from an interner.

Can be used to resolve to the associated instance.

Implementations

impl<T> Symbol<'_, T>

pub fn into_untracked(self) -> UntrackedSymbol<T>

Removes the lifetime tracking for this symbol.

Note

• This can be useful in situations where a data structure owns all symbols and interners and can verify accesses by itself.
• For further safety reasons an untracked symbol can no longer be used to resolve from an interner. It is still useful for serialization purposes.

Safety

Although removing lifetime constraints this operation can be considered to be safe since untracked symbols can no longer be used to resolve their associated instance from the interner.

Trait Implementations

impl<'a, T: Clone + 'a> Clone for Symbol<'a, T>

fn clone(&self) -> Symbol<'a, T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, T: Debug + 'a> Debug for Symbol<'a, T>

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

Formats the value using the given formatter.

impl<'a, T: Ord + 'a> Ord for Symbol<'a, T>

fn cmp(&self, other: &Symbol<'a, T>) -> 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<'a, T: PartialEq + 'a> PartialEq for Symbol<'a, T>

fn eq(&self, other: &Symbol<'a, T>) -> 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<'a, T: PartialOrd + 'a> PartialOrd for Symbol<'a, T>

fn partial_cmp(&self, other: &Symbol<'a, T>) -> 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<'a, T: Copy + 'a> Copy for Symbol<'a, T>

impl<'a, T: Eq + 'a> Eq for Symbol<'a, T>

impl<'a, T: 'a> StructuralPartialEq for Symbol<'a, T>