Struct gluon_base::symbol::SymbolModule

pub struct SymbolModule<'a> { /* fields omitted */ }

SymbolModule wraps a Symbols struct and adds a prefix to all symbols created by the symbol method. While this prefix does not affect the uniques of a Symbol in any way, it does make the origin of a symbol clearer when pretty printing it

Implementations

impl<'a> SymbolModule<'a>

pub fn new(module: String, symbols: &'a mut Symbols) -> SymbolModule<'a>

pub fn simple_symbol<N>(&mut self, name: N) -> Symbol where
    N: Into<NameBuf> + AsRef<Name>, 

pub fn symbol<N>(&mut self, name: SymbolData<N>) -> Symbol where
    N: Into<NameBuf> + AsRef<Name>, 

Creates an unprefixed symbol, same as Symbols::symbol

pub fn contains_name<N>(&mut self, name: N) -> bool where
    N: AsRef<Name>, 

pub fn scoped_symbol(&mut self, name: &str) -> Symbol

Creates a symbol which is prefixed by the module argument passed in new

let mut symbols = Symbols::new();
let mut symbols = SymbolModule::new(String::from("test"), &mut symbols);
assert_eq!(symbols.simple_symbol("a").as_ref(), "a");
assert_eq!(symbols.scoped_symbol("a").as_ref(), "test.a");

pub fn module(&self) -> &Name

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn symbols(&mut self) -> &mut Symbols

Trait Implementations

impl<'a> Debug for SymbolModule<'a>

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

Formats the value using the given formatter.

impl<'s> DisplayEnv for SymbolModule<'s>

type Ident = Symbol

fn string<'a>(&'a self, ident: &'a Self::Ident) -> &'a str

impl<'a> IdentEnv for SymbolModule<'a>

fn from_str(&mut self, s: &str) -> Symbol