engish 0.3.9

A language utility for sampling and building words.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32

use serde::{Deserialize, Serialize};
use std::collections::BTreeSet;

/// A collection of letters that are grouped together, such as vowels, consonants, etc.
#[derive(Serialize, Deserialize, Clone, Debug)]
pub struct LetterGroup {
    /// The letters in this group
    pub letters: BTreeSet<char>,
    /// does a word require one of these?
    pub required: bool,
}

impl LetterGroup {
    /// Vowels of the English language.
    pub fn vowels() -> Self {
        Self {
            letters: BTreeSet::from(['a', 'e', 'i', 'o', 'u']),
            required: true,
        }
    }

    /// Consonants of the English language. 
    pub fn consonants() -> Self {
        Self {
            letters: BTreeSet::from([
                'b', 'c', 'd', 'f', 'g', 'h', 'j', 'k', 'l', 'm', 'n', 'p', 'q', 'r', 's', 't',
                'v', 'w', 'x', 'y', 'z',
            ]),
            required: false,
        }
    }
}