Struct syntax::symbol::InternedString

pub struct InternedString { /* fields omitted */ }

An alternative to Symbol that is focused on string contents. It has two main differences to Symbol.

First, its implementations of Hash, PartialOrd and Ord work with the string chars rather than the symbol integer. This is useful when hash stability is required across compile sessions, or a guaranteed sort ordering is required.

Second, gensym-ness is irrelevant. E.g.:

assert_ne!(Symbol::gensym("x"), Symbol::gensym("x"))
assert_eq!(Symbol::gensym("x").as_interned_str(), Symbol::gensym("x").as_interned_str())

Methods

impl InternedString

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

Maps a string to its interned representation.

pub fn with<F, R>(self, f: F) -> R where
    F: FnOnce(&str) -> R, 

pub fn as_symbol(self) -> Symbol

pub fn as_str(self) -> LocalInternedString

Trait Implementations

impl PartialEq<InternedString> for InternedString

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

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

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

This method tests for !=.

impl Display for InternedString

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

Formats the value using the given formatter.

impl Decodable for InternedString

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

impl Eq for InternedString

impl Ord for InternedString

fn cmp(&self, other: &InternedString) -> 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.

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialOrd<InternedString> for InternedString

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

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

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

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

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

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

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

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

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

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

impl Debug for InternedString

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

Formats the value using the given formatter.

impl Clone for InternedString

fn clone(&self) -> InternedString

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Encodable for InternedString

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

impl Copy for InternedString

impl Hash for InternedString

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