tomb 0.2.0

A minimal crate that provides dice rolling mechanisms for games
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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157

/// A trait that creates elements by use of _step_ functions, i.e. seeking forward or backward.
pub trait Step {
    /// Steps _forward_ logically, for whatever that means, returning rotated by 1.
    #[must_use]
    fn next(&self) -> Self;

    /// Steps _backward_ logically, for whatever that means, returning rotated by -1.
    #[must_use]
    fn back(&self) -> Self;
}

/// A trait that mutates state by use of _step_ functions, i.e. seeking forward or backward.
pub trait StepMut {
    /// Steps _forward_ logically, for whatever that means, rotating by 1.
    fn next_mut(&mut self);

    /// Steps _backward_ logically, for whatever that means, rotating by -1.
    fn back_mut(&mut self);
}

/// A trait that can create rotated (forwards or backwards) elements given a number.
pub trait Rotate
where
    Self: Clone + Step,
{
    /// Rotates either forwards or backwards, based on the given amount.
    ///
    /// # Performance
    ///
    /// The default implementation is naive, and uses a loop combined with `next` and `back`, or
    /// `O(n)` where n is the `amount`. Where possible, replace this method with one that can seek
    /// directly and has better runtime and memory performance.
    #[allow(clippy::comparison_chain)]
    #[must_use]
    fn rotate(&self, amount: i8) -> Self {
        let mut next = self.clone();
        if amount == 0 {
            return next;
        }
        let forwards = amount > 0;
        let mut amount = amount.abs();
        while amount > 0 {
            next = if forwards { next.next() } else { next.back() };
            amount -= 1;
        }
        next
    }
}

/// A trait that can rotate (mutating; forwards or backwards) elements given a number.
pub trait RotateMut
where
    Self: StepMut,
{
    /// Rotates either forwards or backwards, based on the given amount.
    ///
    /// # Performance
    ///
    /// The default implementation is naive, and uses a loop combined with `next` and `back`, or
    /// `O(n)` where n is the `amount`. Where possible, replace this method with one that can seek
    /// directly and has better runtime and memory performance.
    #[allow(clippy::comparison_chain)]
    fn rotate_mut(&mut self, amount: i8) {
        if amount == 0 {
            return;
        }
        let forwards = amount > 0;
        let mut amount = amount.abs();
        while amount > 0 {
            if forwards {
                self.next_mut();
            } else {
                self.back_mut();
            };
            amount -= 1;
        }
    }
}

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

    #[derive(Clone)]
    struct FakeDie(i8);

    impl Step for FakeDie {
        fn next(&self) -> Self {
            FakeDie(self.0 + 1)
        }

        fn back(&self) -> Self {
            FakeDie(self.0 - 1)
        }
    }

    impl StepMut for FakeDie {
        fn next_mut(&mut self) {
            self.0 += 1
        }

        fn back_mut(&mut self) {
            self.0 -= 1
        }
    }

    impl Rotate for FakeDie {}
    impl RotateMut for FakeDie {}

    #[test]
    fn rotate_impl_none() {
        let d = FakeDie(0);
        let r = d.rotate(0);

        assert_eq!(r.0, 0);
    }

    #[test]
    fn rotate_impl_forwards() {
        let d = FakeDie(0);
        let r = d.rotate(2);

        assert_eq!(r.0, 2);
    }

    #[test]
    fn rotate_impl_backwards() {
        let d = FakeDie(0);
        let r = d.rotate(-2);

        assert_eq!(r.0, -2);
    }

    #[test]
    fn rotate_mut_impl_none() {
        let mut d = FakeDie(0);
        d.rotate_mut(0);

        assert_eq!(d.0, 0);
    }

    #[test]
    fn rotate_mut_impl_forwards() {
        let mut d = FakeDie(0);
        d.rotate_mut(2);

        assert_eq!(d.0, 2);
    }

    #[test]
    fn rotate_mut_impl_backwards() {
        let mut d = FakeDie(0);
        d.rotate_mut(-2);

        assert_eq!(d.0, -2);
    }
}