Struct WordDictionary 

pub struct WordDictionary { /* private fields */ }

A word-based dictionary for encoding binary data as word sequences.

Unlike character-based Dictionary, this uses whole words as encoding symbols. Designed for BIP-39, Diceware, PGP word lists, and custom word-based encodings.

Example

use base_d::WordDictionary;

let dict = WordDictionary::builder()
    .words(vec!["abandon", "ability", "able", "about"])
    .delimiter(" ")
    .build()
    .unwrap();

assert_eq!(dict.base(), 4);
assert_eq!(dict.encode_word(0), Some("abandon"));
assert_eq!(dict.decode_word("ability"), Some(1));

Implementations

impl WordDictionary

pub fn builder() -> WordDictionaryBuilder

Creates a new WordDictionaryBuilder for constructing a WordDictionary.

pub fn base(&self) -> usize

Returns the base (number of words) in this dictionary.

pub fn delimiter(&self) -> &str

Returns the delimiter used between words in encoded output.

pub fn case_sensitive(&self) -> bool

Returns whether this dictionary uses case-sensitive matching.

pub fn encode_word(&self, index: usize) -> Option<&str>

Encodes a digit (0 to base-1) as a word.

Returns None if the index is out of range.

pub fn decode_word(&self, word: &str) -> Option<usize>

Decodes a word back to its index value.

Returns None if the word is not in the dictionary. Matching respects the case_sensitive setting.

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

Returns an iterator over all words in the dictionary.

Trait Implementations

impl Clone for WordDictionary

fn clone(&self) -> WordDictionary

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WordDictionary

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

Formats the value using the given formatter.