tengwar 1.1.0

Transliterate text into J.R.R. Tolkien's Tengwar.
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

/// A diacritical vowel marker that may be rendered in an alternate "long" form.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(Deserialize, Serialize))]
pub struct Tehta {
    /// The primary form taken by this tehta.
    pub base: char,
    /// A secondary form that may be used to represent a long vowel.
    pub alternate: Option<char>,
    /// Indicates whether the primary form may be printed twice.
    pub can_double: bool,
}

impl Tehta {
    /// Define a tehta with only one shape. To lengthen it will require the
    ///     extended carrier.
    pub const fn single(base: char) -> Self {
        Self { base, alternate: None, can_double: false }
    }

    /// Define a tehta with one shape, which can be printed twice to indicate a
    ///     lengthened vowel.
    pub const fn double(base: char) -> Self {
        Self { base, alternate: None, can_double: true }
    }

    /// Define a tehta with two shapes. A lengthened vowel may be represented by
    ///     printing either the second shape once, or the first shape twice.
    pub const fn altern(base: char, alt: char) -> Self {
        Self { base, alternate: Some(alt), can_double: true }
    }

    /*pub const fn as_single(mut self) -> Self {
        self.alternate = None;
        self.can_double = false;
        self
    }*/

    /// Add a secondary form that may be used to represent a long vowel.
    pub const fn with_alt(mut self, alt: char) -> Self {
        self.alternate = Some(alt);
        self
    }

    /// Specify that the basic shape of this tehta may be printed twice to
    ///     represent a long vowel.
    pub const fn with_double(mut self) -> Self {
        self.can_double = true;
        self
    }

    /// Return `true` if the long variant of this tehta *must* be written with
    ///     the extended carrier.
    pub const fn needs_ara(&self) -> bool {
        !(self.can_double || self.alternate.is_some())
    }
}