Struct witty_phrase_generator::WPGen

pub struct WPGen { /* fields omitted */ }

Implementations

impl WPGen

pub fn new() -> WPGen

pub fn generic(
    &self,
    words: usize,
    count: usize,
    len_min: Option<usize>,
    len_max: Option<usize>,
    start_char: Option<char>
) -> Option<Vec<Vec<&'static str>>>

Generate the requested phrases if possible

Returns None if the conditions could not be satisfied

All words (even across phrases) will start with start_char if it is provided. To allow different phrases to alliterate with different letters, use with_phrasewise_alliteration instead.

pub fn with_phrasewise_alliteration(
    &self,
    words: usize,
    count: usize,
    len_min: Option<usize>,
    len_max: Option<usize>
) -> Option<Vec<Vec<&'static str>>>

Generate the requested phrases if possible

Returns None if the conditions could not be satisfied

Each phrase will alliterate internally, but different phrases may start with different letters. To specify what letter to start with, use generic() instead.

pub fn with_words(&self, words: usize) -> Option<Vec<&'static str>>

Generate a witty phrase with either 1, 2, or 3 words

returns None when no phrase could be generated (eg. if one of the wordlists is empty)