Struct MultiListIndexingWordlist 

pub struct MultiListIndexingWordlist { /* private fields */ }

Some wordlists are actually multiple lists, some have two (i.e. an even and an odd list) but this interface abstracts around having multiple wordlists based on the index of the word in the vec being used to index into which worldlist.

Implementations

impl MultiListIndexingWordlist

pub fn new( name: String, wordlists: Vec<Box<[&'static str]>>, ) -> MultiListIndexingWordlist

Create a new wordlist out of multiple lists of words.

pub fn word(&self, index: &usize, count: usize) -> Result<&'static str>

Given some index into the wordlist, and the current count of indexes we’re at (i.e. the index into the wordlist and the wordlist index), find the word.

For example, if there are 2 wordlists which make up this multi-list wordlist, and the index of the word is 15 and the count is 10 (the tenth index in the list); we would do something like: self.wordlists[10 % 2][index]. Namely, check which wordlist to query, and then index into it.

pub fn index(&self, word: &str, count: usize) -> Result<usize>

Given some word and it’s current count we’re at (i.e. the wordlist index), find the index.

For example, if there are 2 wordlists which make up this multi-list wordlist, and the count is 10 (the tenth word in the WordVec, we would do something like: self.wordlists[10 % 2].index_of(word). Namely, check which wordlist to query, and then retrieve the index.

Trait Implementations

impl Wordlist for MultiListIndexingWordlist

fn name(&self) -> &String

The name of this Wordlist.

fn size(&self) -> usize

The length of the wordlist. If this wordlist describes multiple lists, this will be one more than the highest acceptable index.

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

Check whether the given word exists in this Wordlist.

fn index_bit_width(&self) -> Result<usize>

Get the number of bits required to index into this wordlist. This may fail if the length of the wordlist is not a valid one for indexing into.

fn validate_word_list(&self, possible_words: &Vec<String>) -> bool

Confirm all words in the given list exist in this wordlist.

impl WordlistByteConverter for MultiListIndexingWordlist

fn to_words(&self, bytes: &BitVec) -> Result<WordVec>

Convert a list of bits into a list of words.

fn to_bytes(&self, wordlist: &WordVec) -> Result<BitVec>

Convert a list of words into a list of bits.