namegen 0.1.4

Fast name generator.
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
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118

use std::error::Error;

use crate::Sample;

/// A WorkingSet is a crucial part of this generator's performance. It is all local state required
/// to generate a name and get the output without performing additional allocations per generation
/// once the WorkingSet's underlying vectors have grown.
/// 
/// This also means that if you have a working set per thread, then generating names is completely
/// thread safe.
///
/// WARNING: While the fields are public, they're not guaranteed in any way. You should always
/// use [`WorkingSet::new()`] to create new working sets.
pub struct WorkingSet {
    pub result: Vec<usize>,
    pub result_str: String,
    pub result_chars: Vec<char>,
    pub result_total: String,
    pub stack: Vec<usize>,
    pub stack_pos: Vec<usize>,
    pub stack_weight: Vec<usize>,
    pub subtokens: Vec<usize>,
}

impl WorkingSet {
    /// Get the results from the last generator call.
    /// If you need to keep it around, copy it to another
    /// string.
    pub fn get_result(&self) -> &str {
        &self.result_str
    }

    pub fn new() -> WorkingSet {
        WorkingSet{
            result: Vec::with_capacity(16),
            result_str: String::with_capacity(16),
            result_chars: Vec::with_capacity(64),
            result_total: String::with_capacity(32),
            stack: Vec::with_capacity(128),
            stack_pos: Vec::with_capacity(16),
            stack_weight: Vec::with_capacity(16),
            subtokens: Vec::new(),
        }
    }
}

#[derive(Debug)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
#[cfg_attr(feature = "serde", serde(rename_all = "camelCase"))]
pub struct LearnError {
    sample: Option<Sample>,
    code: usize,
    desc: String,
}

impl LearnError {
    pub fn new(code: usize, desc: String, sample: Option<Sample>) -> LearnError {
        LearnError{code, desc, sample}
    }
}

impl std::fmt::Display for LearnError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match &self.sample {
            Some(sample) => write!(f, "LearError {:?}: {} (code: {})", sample, self.desc, self.code),
            None => write!(f, "LearError: {} (code: {})", self.desc, self.code),
        }
    }
}

impl Error for LearnError {
    fn source(&self) -> Option<&(dyn Error + 'static)> {
        None
    }

    fn description(&self) -> &str {
        &self.desc
    }
}

#[derive(Debug)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
#[cfg_attr(feature = "serde", serde(rename_all = "camelCase"))]
pub struct ValidationError {
    kind: &'static str,
    name: String,
    message: &'static str,
}

impl ValidationError {
    pub fn with_name(&self, name: &str) -> ValidationError {
        ValidationError{
            kind: self.kind,
            message: self.message,
            name: name.to_owned(),
        }
    }

    pub fn new(kind: &'static str, message: &'static str) -> ValidationError {
        ValidationError{kind, message, name: String::new()}
    }
}

impl std::fmt::Display for ValidationError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}({}): {}", self.kind, self.name, self.message)
    }
}

impl Error for ValidationError {
    fn source(&self) -> Option<&(dyn Error + 'static)> {
        None
    }

    fn description(&self) -> &str {
        &self.message
    }
}