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
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54

use crate::{Wordlist, WordlistError};
use once_cell::sync::Lazy;

/// The list of words as supported in the English language.
pub const RAW_ENGLISH: &str = include_str!("./words/english.txt");

/// English word list, split into words
pub static PARSED: Lazy<Vec<&'static str>> = Lazy::new(|| RAW_ENGLISH.lines().collect());

#[derive(Clone, Debug, PartialEq, Eq, Copy)]
/// The English wordlist that implements the Wordlist trait.
pub struct English;

impl Wordlist for English {
    fn get_all() -> &'static [&'static str] {
        PARSED.as_slice()
    }

    /// Returns the index of a given word from the word list.
    fn get_index(word: &str) -> Result<usize, WordlistError> {
        Self::get_all()
            .binary_search(&word)
            .map_err(|_| crate::WordlistError::InvalidWord(word.to_string()))
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    use crate::WordlistError;

    #[test]
    fn test_get() {
        assert_eq!(English::get(3), Ok("about"));
        assert_eq!(English::get(2044), Ok("zebra"));
        assert_eq!(English::get(2048), Err(WordlistError::InvalidIndex(2048)));
    }

    #[test]
    fn test_get_index() {
        assert_eq!(English::get_index("about"), Ok(3));
        assert_eq!(English::get_index("zebra"), Ok(2044));
        assert_eq!(
            English::get_index("somerandomword"),
            Err(WordlistError::InvalidWord("somerandomword".to_string()))
        );
    }

    #[test]
    fn test_get_all() {
        assert_eq!(English::get_all().len(), 2048);
    }
}