Struct Symbol

pub struct Symbol(/* private fields */);

Identifies an interned string.

Implementations

impl Symbol

pub fn new(s: &str) -> Symbol

Gets a symbol from the given string.

Example

use interner::Symbol;

let kw_const = Symbol::new("const");
kw_const.borrow(|s| assert_eq!(s, "const"));

pub fn borrow<R>(&self, f: impl FnOnce(&str) -> R) -> R

Borrows this symbol from the global interner, and applies the given closure to it

Example

use interner::Symbol;

let sym = Symbol::new("my string");
sym.borrow(|s| {
    println!("Symbol {sym:?} resolved to '{s}'");
});

Trait Implementations

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

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

Formats the value using the given formatter.

impl Display for Symbol

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

Formats the value using the given formatter.

impl FromStr for Symbol

type Err = Infallible

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Symbol, <Symbol as FromStr>::Err>

Parses a string s to return a value of this type.

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq<&str> for Symbol

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

Attemps to resolve the symbol, and compares it with the given string

NOTE: If the symbol doesn’t exist in the session storage, it returns false.

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

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

impl Eq for Symbol

impl StructuralPartialEq for Symbol