Struct rustfst::SymbolTable

pub struct SymbolTable<H: BuildHasher = RandomState> { /* private fields */ }

A symbol table stores a bidirectional mapping between transition labels and “symbols” (strings).

Implementations

impl SymbolTable

pub fn new() -> Self

Creates a SymbolTable with a single element in it: the pair (EPS_LABEL, EPS_SYMBOL).

Examples

let mut symt = SymbolTable::new();

pub fn empty() -> Self

pub fn from_text_string(symt_string: &str) -> Result<Self>

pub fn read_text<P: AsRef<Path>>(path_text_symt: P) -> Result<Self>

pub fn read<P: AsRef<Path>>(path_bin_symt: P) -> Result<Self>

impl<H: BuildHasher> SymbolTable<H>

pub fn with_hasher(hasher_builder: H) -> Self

pub fn is_empty(&self) -> bool

pub fn add_symbol(&mut self, sym: impl Into<String>) -> Label

Adds a symbol to the symbol table. The corresponding label is returned.

Examples

let mut symt = symt!["a", "b"];

// Elements in the table : `<eps>`, `a`, `b`
assert_eq!(symt.len(), 3);

// Add a single symbol
symt.add_symbol("c");

// Elements in the table : `<eps>`, `a`, `b`, `c`
assert_eq!(symt.len(), 4);

pub fn add_symbols<S: Into<String>, P: IntoIterator<Item = S>>(
    &mut self,
    symbols: P
)

pub fn len(&self) -> usize

Returns the number of symbols stored in the symbol table.

Examples

let mut symt = symt!["a", "b"];
assert_eq!(symt.len(), 3);

pub fn get_label(&self, sym: impl AsRef<str>) -> Option<Label>

Given a symbol, returns the label corresponding. If the symbol is not stored in the table then None is returned.

Examples

let mut symt = symt!["a", "b"];
let label = symt.add_symbol("c");
assert_eq!(symt.get_label("c"), Some(label));
assert_eq!(symt.get_label("d"), None);

pub fn get_symbol(&self, label: Label) -> Option<&str>

Given a label, returns the symbol corresponding. If no there is no symbol with this label in the table then None is returned.

Examples

let mut symt = symt!["a", "b"];
let label = symt.add_symbol("c");
assert_eq!(symt.get_symbol(label), Some("c"));
assert_eq!(symt.get_symbol(label + 1), None);

pub fn contains_symbol(&self, sym: impl AsRef<str>) -> bool

Given a symbol, returns whether it is present in the table.

Examples

let symt = symt!["a", "b"];
assert!(symt.contains_symbol("a"));

pub fn contains_label(&self, label: Label) -> bool

Given a label, returns whether it is present in the table.

Examples

let mut symt = symt!["a", "b"];
let label = symt.add_symbol("c");
assert!(symt.contains_label(label));
assert!(!symt.contains_label(label+1));

pub fn reserve(&mut self, additional: usize)

Reserves capacity for at least additional more elements to be inserted in the SymbolTable. The collection may reserve more space to avoid frequent reallocations.

pub fn labels(&self) -> impl Iterator<Item = Label>

An iterator on all the labels stored in the SymbolTable. The iterator element is &'a Label.

Examples

let symt = symt!["a", "b"];
let mut iterator = symt.labels();

pub fn symbols(&self) -> impl Iterator<Item = &str>

An iterator on all the symbols stored in the SymbolTable. The iterator element is &'a Symbol.

Examples

let symt = symt!["a", "b"];
let mut iterator = symt.symbols();

for symbol in symt.symbols() {
    println!("Symbol : {:?}", symbol);
}

pub fn iter(&self) -> impl Iterator<Item = (Label, &str)>

An iterator on all the labels stored in the SymbolTable. The iterator element is (&'a Label, &'a Symbol).

pub fn add_table(&mut self, other: &SymbolTable)

Adds another SymbolTable to this table.

pub fn write_text<P: AsRef<Path>>(&self, path_output: P) -> Result<()>

pub fn write<P: AsRef<Path>>(&self, path_bin_symt: P) -> Result<()>

pub fn text(&self) -> Result<String>

Writes the text_fst representation of the symbol table into a String.

Trait Implementations

impl<H: Clone + BuildHasher> Clone for SymbolTable<H>

fn clone(&self) -> SymbolTable<H>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<H: Debug + BuildHasher> Debug for SymbolTable<H>

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

Formats the value using the given formatter.

impl Default for SymbolTable

fn default() -> Self

Returns the “default value” for a type.

impl<H: BuildHasher> Display for SymbolTable<H>

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

Formats the value using the given formatter.

impl<H: BuildHasher> PartialEq<SymbolTable<H>> for SymbolTable<H>

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.