use-dimension 0.0.6

Dimension 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
51
52
53

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

/// A positive spatial dimension count.
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct Dimension(usize);

impl Dimension {
    /// One-dimensional space.
    pub const ONE: Self = Self(1);
    /// Two-dimensional space.
    pub const TWO: Self = Self(2);
    /// Three-dimensional space.
    pub const THREE: Self = Self(3);

    /// Creates a positive dimension count.
    #[must_use]
    pub const fn new(value: usize) -> Option<Self> {
        if value == 0 { None } else { Some(Self(value)) }
    }

    /// Creates a dimension count without checking whether it is positive.
    #[must_use]
    pub const fn new_unchecked(value: usize) -> Self {
        Self(value)
    }

    /// Returns the numeric dimension count.
    #[must_use]
    pub const fn value(self) -> usize {
        self.0
    }

    /// Returns `true` for dimensions commonly used as spatial geometry.
    #[must_use]
    pub const fn is_spatial(self) -> bool {
        self.0 <= 3
    }
}

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

    #[test]
    fn validates_positive_dimensions() {
        assert_eq!(Dimension::new(0), None);
        assert_eq!(Dimension::new(2), Some(Dimension::TWO));
        assert_eq!(Dimension::THREE.value(), 3);
        assert!(Dimension::THREE.is_spatial());
        assert!(!Dimension::new_unchecked(4).is_spatial());
    }
}