detexify 0.4.0

The `detexify` crate is a port of the classifier that powers https://detexify.kirelabs.org/classify.html.
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

extern crate phf;

include!(concat!(env!("OUT_DIR"), "/symbol_table.rs"));

#[derive(Debug, Clone, PartialEq)]
pub struct Symbol {
    pub command: &'static str,
    pub package: &'static str,
    pub font_encoding: &'static str,
    pub text_mode: bool,
    pub math_mode: bool,
}

impl Symbol {
    pub fn from_id(id: &str) -> Option<Self> {
        SYMBOL_TABLE.get(id).cloned()
    }

    pub fn id(&self) -> &'static str {
        let id = format!(
            "{}-{}-{}",
            self.package,
            self.font_encoding,
            self.command.replace("\\", "_")
        );

        // TODO: remove this once https://github.com/sfackler/rust-phf/pull/185 is merged
        Box::leak(
            base32::encode(base32::Alphabet::RFC4648 { padding: false }, id.as_bytes())
                .into_boxed_str(),
        )
    }
}

pub fn iter_symbols() -> impl Iterator<Item = Symbol> {
    SYMBOL_TABLE.values().cloned()
}

#[cfg(test)]
mod tests {

    use super::Symbol;
    use crate::iter_symbols;

    #[test]
    fn test_from_id() {
        let symbol = Symbol::from_id("NRQXIZLYGJSS2T2UGEWV65DFPB2GC43DNFUWG2LSMN2W2");

        assert_eq!(
            symbol,
            Some(Symbol {
                command: "\\textasciicircum",
                package: "latex2e",
                font_encoding: "OT1",
                text_mode: true,
                math_mode: false
            })
        );
    }

    #[test]
    fn test_iterate_symbols() {
        assert_eq!(iter_symbols().count(), 1098);
    }

    #[test]
    fn test_id_get_id() {
        for symbol in iter_symbols() {
            assert_eq!(Symbol::from_id(symbol.id()).unwrap(), symbol);
        }
    }
}