Struct jupiter::ig::symbols::SymbolTable
source · pub struct SymbolTable { /* private fields */ }
Expand description
Used to resolve and lookup symbols.
Implementations§
source§impl SymbolTable
impl SymbolTable
sourcepub fn new() -> Self
pub fn new() -> Self
Creates a new and empty symbol table.
§Example
let table = SymbolTable::new();
assert_eq!(table.len(), 0);
sourcepub fn resolve(&self, string: impl AsRef<str>) -> Option<Symbol>
pub fn resolve(&self, string: impl AsRef<str>) -> Option<Symbol>
Tries to resolve the given string
into an existing Symbol
.
If no symbol with the given name is known, None
is returned. If a new
symbol should be created instead, use find_or_create
.
§Example
let mut table = SymbolTable::new();
let symbol = table.find_or_create("Test").unwrap();
assert_eq!(table.resolve("Test").unwrap(), symbol);
assert_eq!(table.resolve("Unknown").is_none(), true);
sourcepub fn find_or_create(&mut self, string: impl AsRef<str>) -> Result<Symbol>
pub fn find_or_create(&mut self, string: impl AsRef<str>) -> Result<Symbol>
Resolve the given string
into a new or an existing Symbol
.
If no symbol should be created if the given name is unknown, use resolve
.
§Errors
This will return an error if the internal symbol table overflows (if there are more than std::i32::MAX - 2 symbols).
§Example
let mut table = SymbolTable::new();
let symbol = table.find_or_create("Test").unwrap();
assert_eq!(table.resolve("Test").unwrap(), symbol);
sourcepub fn lookup(&self, symbol: Symbol) -> &str
pub fn lookup(&self, symbol: Symbol) -> &str
Retrieves the name of the given Symbol
.
§Examples
let mut table = SymbolTable::new();
let symbol = table.find_or_create("Test").unwrap();
// A known symbol can be looked up...
assert_eq!(table.lookup(symbol), "Test");
// An unknown symbol is simply translated to ""
assert_eq!(table.lookup(1024), "");
sourcepub fn len(&self) -> usize
pub fn len(&self) -> usize
Determines the number of known symbols in the table.
§Examples
let mut table = SymbolTable::new();
// The same symbol is only added once to a table...
let symbol = table.find_or_create("Test").unwrap();
let symbol1 = table.find_or_create("Test").unwrap();
assert_eq!(symbol, symbol1);
// ..therefore the table size is 1.
assert_eq!(table.len(), 1);
// If we add another symbol...
table.find_or_create("Test 2").unwrap();
// ...the size grows to 2.
assert_eq!(table.len(), 2);
sourcepub fn is_empty(&self) -> bool
pub fn is_empty(&self) -> bool
Determines if the symbol table is empty.
§Examples
let mut table = SymbolTable::new();
assert_eq!(table.is_empty(), true);
let _ = table.find_or_create("Test").unwrap();
assert_eq!(table.is_empty(), false);
sourcepub fn allocated_size(&self) -> usize
pub fn allocated_size(&self) -> usize
Estimates the allocated memory required to represent the symbol table.
Note that this is only an approximation as some inner types to not reveal their size.
§Example
let mut table = SymbolTable::new();
table.find_or_create("Hello").unwrap();
table.find_or_create("World").unwrap();
println!("{}", table.allocated_size());
Trait Implementations§
source§impl Clone for SymbolTable
impl Clone for SymbolTable
source§fn clone(&self) -> SymbolTable
fn clone(&self) -> SymbolTable
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Default for SymbolTable
impl Default for SymbolTable
source§fn default() -> SymbolTable
fn default() -> SymbolTable
Auto Trait Implementations§
impl Freeze for SymbolTable
impl RefUnwindSafe for SymbolTable
impl Send for SymbolTable
impl Sync for SymbolTable
impl Unpin for SymbolTable
impl UnwindSafe for SymbolTable
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more