Struct MappedLexicon 

pub struct MappedLexicon { /* private fields */ }

Memory-mapped lexicon view with owning storage.

Binary search over on-disk sorted trigram table.

Implementations

impl MappedLexicon

pub fn from_entries(entries: &[LexiconEntry]) -> Self

Construct from a list of lexicon entries (used by the builder for in-memory index).

Panics

Panics if entries.len() exceeds u32::MAX.

pub fn open(path: &Path) -> Result<Self>

Open a lexicon from a memory-mapped file.

Errors

Returns an error if the file is malformed.

pub const fn len(&self) -> usize

pub const fn is_empty(&self) -> bool

pub fn get(&self, tri: [u8; 3]) -> Option<LexiconEntry>

Binary search for tri in the mapped lexicon. Returns the entry if found.

Panics

Panics if the internal data layout is corrupted (out of bounds read).

pub const fn iter(&self) -> MappedLexiconIter<'_>

pub fn backing_slice(&self) -> &[u8]

Trait Implementations

impl Debug for MappedLexicon

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

Formats the value using the given formatter.

impl<'a> IntoIterator for &'a MappedLexicon

type Item = LexiconEntry

The type of the elements being iterated over.

type IntoIter = MappedLexiconIter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.