use-wythoff 0.0.6

Wythoff notation primitives for the RustUse geometry workspace
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

#![forbid(unsafe_code)]
#![doc = include_str!("../README.md")]

use core::fmt;

/// A lightweight Wythoff construction symbol.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct WythoffSymbol {
    notation: String,
}

impl WythoffSymbol {
    /// Creates a Wythoff symbol from non-empty notation.
    #[must_use]
    pub fn new(notation: impl Into<String>) -> Option<Self> {
        let notation = notation.into();

        if notation.trim().is_empty() {
            None
        } else {
            Some(Self { notation })
        }
    }

    /// Returns the notation string.
    #[must_use]
    pub fn notation(&self) -> &str {
        &self.notation
    }
}

impl fmt::Display for WythoffSymbol {
    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
        formatter.write_str(&self.notation)
    }
}

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

    #[test]
    fn stores_wythoff_notation() {
        let symbol = WythoffSymbol::new("3 | 4 2").expect("valid symbol");

        assert_eq!(symbol.notation(), "3 | 4 2");
        assert_eq!(symbol.to_string(), "3 | 4 2");
        assert_eq!(WythoffSymbol::new("   "), None);
    }
}