Struct string_interner::Sym

pub struct Sym(_);

Symbol type used by the DefaultStringInterner.

Note

This special symbol type has a memory footprint of 32 bits and allows for certain space optimizations such as using it within an option: Option<Sym>

Trait Implementations

impl Debug for Sym

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

Formats the value using the given formatter.

impl Copy for Sym

impl Clone for Sym

fn clone(&self) -> Sym

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq for Sym

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

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

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

This method tests for !=.

impl Eq for Sym

impl PartialOrd for Sym

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

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

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

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

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

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

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

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

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

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

impl Ord for Sym

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

impl Hash for Sym

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

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].

impl Symbol for Sym

fn from_usize(val: usize) -> Self

Creates a Sym from the given usize.

Panics

If the given usize is greater than u32::MAX - 1.

fn to_usize(self) -> usize

Returns the usize representation of self.