Struct WordAllocator 

pub struct WordAllocator { /* private fields */ }

An IdAllocator over a fixed list of words.

It hands the words out in list order, moving on past each one it leases, so a word just released is the last to come back. Default uses a built-in list of 2048 common English words.

Implementations

impl WordAllocator

pub fn new<W: Into<Box<str>>>(words: impl IntoIterator<Item = W>) -> Self

An allocator handing out words.

Panics

Panics when words is empty, holds one word twice, or holds a word that is not one or more lowercase ASCII letters.

Trait Implementations

impl Debug for WordAllocator

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

Formats the value using the given formatter.

impl Default for WordAllocator

fn default() -> Self

Returns the “default value” for a type.

impl IdAllocator for WordAllocator

fn lease(&self) -> Result<String, IdsExhausted>

Leases a word that no live lease holds.

fn release(&self, word: &str)

Ends the lease of word, which lease handed out and which has not been released since.