Struct prompter::Wordlist

pub struct Wordlist(_);

A list of Words

Implementations

impl Wordlist

pub fn load() -> Self

Loads the default wordlist from a file.

pub fn len(&self) -> usize

Returns the number of words in the list.

pub fn is_empty(&self) -> bool

Returns true if no words are in the list.

pub fn iter(&self) -> Iter<'_, Word>

Returns an iterator over references to the words in the list.

pub fn filter(
    self,
    constraints: &ConstraintSet
) -> impl Iterator<Item = Word> + '_

Returns an iterator over the words in the list that comply to the given constraints.

pub fn rank_words(&self) -> impl Iterator<Item = (&Word, usize)>

Ranks the words in the list by their filter_potential and returns an iterator over pairs of word references and scores. The return values are sorted by the score in descending order. Two words with the same score will be sorted lexicographically.

pub fn remove(&mut self, word: &str)

Removes the given word from the list if it exists.

Trait Implementations

impl Default for Wordlist

fn default() -> Wordlist

Returns the “default value” for a type.

impl<P: AsRef<Path>> From<P> for Wordlist

fn from(path: P) -> Self

Loads a wordlist from a text file.

impl FromIterator<Word> for Wordlist

fn from_iter<I: IntoIterator<Item = Word>>(iter: I) -> Self

Creates a value from an iterator.

impl IntoIterator for Wordlist

type Item = Word

The type of the elements being iterated over.

type IntoIter = IntoIter<Word, Global>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a> IntoIterator for &'a Wordlist

type Item = &'a Word

The type of the elements being iterated over.

type IntoIter = Iter<'a, Word>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.