oneoff 0.1.0

oneoff is a library for one-off types
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
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90

/// One off Left or Right type
#[derive(Debug, PartialEq, PartialOrd, Eq, Ord, Hash, Clone, Copy)]
pub enum OneOff<T> {
    Left(T),
    Right(T),
}

impl<T> OneOff<T> {
    /// Returns the left value if it exists
    ///
    /// # Examples
    ///
    /// ```
    /// use oneoff::OneOff;
    /// let left = OneOff::Left(1);
    /// let right = OneOff::Right(2);
    /// assert_eq!(left.left(), Some(1));
    /// assert_eq!(right.left(), None);
    /// ```
    pub fn left(self) -> Option<T> {
        match self {
            OneOff::Left(t) => Some(t),
            _ => None,
        }
    }

    /// Returns the right value if it exists
    ///
    /// # Examples
    ///
    /// ```
    /// use oneoff::OneOff;
    /// let left = OneOff::Left(1);
    /// let right = OneOff::Right(2);
    /// assert_eq!(left.right(), None);
    /// assert_eq!(right.right(), Some(2));
    /// ```
    pub fn right(self) -> Option<T> {
        match self {
            OneOff::Right(t) => Some(t),
            _ => None,
        }
    }

    /// returns true if the value is a left
    ///
    /// # Examples
    ///
    /// ```
    /// use oneoff::OneOff;
    /// let left = OneOff::Left(1);
    /// let right = OneOff::Right(2);
    /// assert!(left.is_left());
    /// assert!(!right.is_left());
    /// ```
    pub fn is_left(&self) -> bool {
        matches!(self, OneOff::Left(_))
    }

    /// returns true if the value is a right
    ///
    /// # Examples
    /// ```
    /// use oneoff::OneOff;
    /// let left = OneOff::Left(1);
    /// let right = OneOff::Right(2);
    /// assert!(!left.is_right());
    /// assert!(right.is_right());
    /// ```
    pub fn is_right(&self) -> bool {
        matches!(self, OneOff::Right(_))
    }
}

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

    #[test]
    fn test_oneoff() {
        let left = OneOff::Left(1);
        let right = OneOff::Right(2);

        assert_eq!(left, OneOff::Left(1));
        assert_eq!(right, OneOff::Right(2));

        assert_eq!(left.cmp(&right), std::cmp::Ordering::Less);
        assert_eq!(right.cmp(&left), std::cmp::Ordering::Greater);
    }
}