Struct syntax::symbol::Symbol

pub struct Symbol(_);

A symbol is an interned or gensymed string. The use of newtype_index! means that Option only takes up 4 bytes, because newtype_index! reserves the last 256 values for tagging purposes.

Note that Symbol cannot be a newtype_index! directly because it implements fmt::Debug, Encodable, and Decodable in special ways.

Methods

impl Symbol

pub fn intern(string: &str) -> Symbol

Maps a string to its interned representation.

pub fn interned(self) -> Symbol

pub fn gensym(string: &str) -> Symbol

Gensyms a new usize, using the current interner.

pub fn gensymed(self) -> Symbol

pub fn as_str(self) -> LocalInternedString

pub fn as_interned_str(self) -> InternedString

pub fn as_u32(self) -> u32

Trait Implementations

impl Copy for Symbol

impl Ord for Symbol

fn cmp(&self, other: &Symbol) -> 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 Display for Symbol

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

Formats the value using the given formatter.

impl !Sync for Symbol

impl Eq for Symbol

impl Decodable for Symbol

fn decode<D>(d: &mut D) -> Result<Symbol, <D as Decoder>::Error> where
    D: Decoder, 

impl<T> PartialEq<T> for Symbol where
    T: Deref<Target = str>, 

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

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

#[must_use]

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

This method tests for !=.

impl PartialEq<Symbol> for Symbol

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

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

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

This method tests for !=.

impl !Send for Symbol

impl Debug for Symbol

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

Formats the value using the given formatter.

impl Clone for Symbol

fn clone(&self) -> Symbol

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialOrd<Symbol> for Symbol

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

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

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

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

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

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

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

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

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 Hash for Symbol

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, 

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

impl Encodable for Symbol

fn encode<S>(&self, s: &mut S) -> Result<(), <S as Encoder>::Error> where
    S: Encoder,