Skip to main content

SynonymMap

Struct SynonymMap 

Source
pub struct SynonymMap(/* private fields */);
Expand description

A canonical-form → synonym-list lookup table.

Built from tab-separated data via SynonymMap::from_tsv. Lookup is O(log n) via BTreeMap (suitable for sets up to ~5 000 entries; use an FST-backed map for larger corpora).

Implementations§

Source§

impl SynonymMap

Source

pub fn empty() -> Self

Create an empty SynonymMap (no expansions).

Source

pub fn from_tsv(data: &str) -> Self

Parse a tab-separated synonym table.

Format: canonical\tsyn1\tsyn2\t… — one rule per line. Lines beginning with # and blank lines are skipped. Lines with fewer than two tab-separated fields are skipped silently.

Source

pub fn expand(&self, word: &str) -> Option<&[String]>

Look up synonym expansions for word.

Returns None if word has no entry. Returns the full synonym slice otherwise — the caller should index all returned strings alongside the canonical form.

Source

pub fn has_synonyms(&self, word: &str) -> bool

Return true if word has synonym expansions.

Source

pub fn len(&self) -> usize

Number of canonical entries in the map.

Source

pub fn is_empty(&self) -> bool

Return true if the map has no entries.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.