Struct Symbol

pub struct Symbol<T, D>
where
    D: SymbolId,
{ /* private fields */ }

A table entry that associates an instance of T with an atomic symbol.

Types T should not be mutated by any means once they are associated with a SymbolId and stored in a Table. Doing so may invalidate any caching or indexing that is done on top of the table.

Implementations

impl<T, D> Symbol<T, D>

where D: SymbolId,

pub fn id(&self) -> &D

Returns the symbol’s ID.

pub fn data(&self) -> &T

Returns a reference to the symbol’s data.

A Symbol<T> that is owned by a Table does not move in memory as long as it is not dropped from the table. As a result, you may retain a raw pointer to this data and dereference it as long as its parent Symbol<T> is not dropped.

Trait Implementations

impl<T: Debug, D> Debug for Symbol<T, D>

where D: SymbolId + Debug,

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

Formats the value using the given formatter.

impl<T, D> Hash for Symbol<T, D>

where T: Hash, D: SymbolId,

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

where H: Hasher,

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T, D> Ord for Symbol<T, D>

where T: Ord, D: SymbolId,

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

where T: PartialEq, D: SymbolId,

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

where T: PartialOrd, D: SymbolId,

fn partial_cmp(&self, other: &Self) -> 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<T, D> Eq for Symbol<T, D>

where T: Eq, D: SymbolId,