Skip to main content

Dictionary

Struct Dictionary 

Source
pub struct Dictionary { /* private fields */ }
Expand description

NNCP token dictionary mapping 16-bit symbol IDs (0..vocab_size) to raw word byte slices.

Implementations§

Source§

impl Dictionary

Source

pub fn from_words(words: Vec<Vec<u8>>) -> Self

Creates a dictionary directly from its ordered word byte entries.

Source

pub fn load(path: impl AsRef<Path>) -> Result<Self, PreprocessError>

Loads a .voc dictionary file in Bellard’s escaped line format.

§Errors

Returns PreprocessError on I/O failure, invalid escape sequences, or entries longer than 4096 bytes.

Source

pub fn from_reader<R: Read>(reader: R) -> Result<Self, PreprocessError>

Parses a .voc dictionary from any Read source.

§Errors

Returns PreprocessError on read errors, invalid escapes, or oversized entries.

Source

pub fn save(&self, path: impl AsRef<Path>) -> Result<(), PreprocessError>

Writes this dictionary to path in Bellard’s escaped line format.

§Errors

Returns PreprocessError::Io on write failure.

Source

pub fn write_to(&self, writer: &mut impl Write) -> Result<(), PreprocessError>

Serializes this dictionary to writer in Bellard’s escaped line format.

§Errors

Returns PreprocessError::Io on write failure.

Source

pub fn words(&self) -> &[Vec<u8>]

Returns all dictionary entries in symbol-ID order.

Source

pub fn len(&self) -> usize

Returns the number of entries in the dictionary.

Source

pub fn is_empty(&self) -> bool

Returns true if the dictionary contains zero entries.

Source

pub fn get(&self, symbol: u16) -> Option<&[u8]>

Looks up the raw byte sequence for symbol ID symbol.

Trait Implementations§

Source§

impl Clone for Dictionary

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Dictionary

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for Dictionary

Source§

impl PartialEq for Dictionary

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Dictionary

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.