charmap 0.2.2

A library for one-to-(none/one/many) character mapping.
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

/// An enum representing an action to be taken by a
/// [`CharMapper`](super::CharMapper) when it sees a certain [`char`].
#[derive(Clone, Copy, Debug)]
pub enum CharMapAction<'a> {
    /// Output the character as is.
    Pass,
    /// Delete the character.
    Delete,
    /// Substitute the character with a string.
    SubStr(&'a str),
    /// Substitute the character with another character.
    SubChar(char),
}

/// A trait that should be implemented by any struct providing char-to-action
/// mappings for [`CharMapper`](super::CharMapper).
pub trait ActionMap {
    /// Map a character to its respective CharMapAction.
    fn map_char(&'_ self, c: char) -> Option<&'_ CharMapAction<'_>>;
}

// ====== ActionMap implementations for most commonly used maps ====== //

#[cfg(feature = "std")]
impl ActionMap for std::collections::HashMap<char, CharMapAction<'_>> {
    #[inline]
    fn map_char(&'_ self, c: char) -> Option<&'_ CharMapAction<'_>> {
        self.get(&c)
    }
}

#[cfg(feature = "std")]
impl ActionMap for std::collections::BTreeMap<char, CharMapAction<'_>> {
    #[inline]
    fn map_char(&'_ self, c: char) -> Option<&'_ CharMapAction<'_>> {
        self.get(&c)
    }
}

#[cfg(feature = "hashbrown")]
impl ActionMap for hashbrown::HashMap<char, CharMapAction<'_>> {
    #[inline]
    fn map_char(&'_ self, c: char) -> Option<&'_ CharMapAction<'_>> {
        self.get(&c)
    }
}

#[cfg(feature = "phf")]
impl ActionMap for phf::Map<char, CharMapAction<'_>> {
    #[inline]
    fn map_char(&'_ self, c: char) -> Option<&'_ CharMapAction<'_>> {
        self.get(&c)
    }
}

#[cfg(feature = "phf")]
impl ActionMap for phf::OrderedMap<char, CharMapAction<'_>> {
    #[inline]
    fn map_char(&'_ self, c: char) -> Option<&'_ CharMapAction<'_>> {
        self.get(&c)
    }
}