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

//! Contains "physical" objects or objects that act on physical objects.
//!
//! A typical app will create and manage one or more _die_, typically [`NumericDie`] which are
//! simpler than [`SliceDie`], and often one of the convenience type such as [`D6`], and either
//! manually work with the dice or use a (recommended) _roller_, typically
//! [`crate::items::RngRoller`].
//!
//! # Examples
//!
//! ```
//! // A static seed is provided in order to make this example predictable.
//! use fastrand::Rng;
//! use tomb::items::{D6, RngRoller};
//! use tomb::traits::{Roll, RollMut};
//!
//! let roller = RngRoller::from(Rng::with_seed(7194422452970863838));
//!
//! // Immutable objects.
//! let d6 = D6::new();
//! let rd = roller.roll(&d6);
//! assert_eq!(rd.value(), 3);
//!
//! // Mutable objects.
//! let mut d6 = D6::new();
//! roller.roll_mut(&mut d6);
//! assert_eq!(rd.value(), 3);
//! ```

mod dice;
mod roller;

pub use dice::*;
pub use roller::*;

#[cfg(test)]
mod tests {
    use fastrand::Rng;

    use crate::items::{RngRoller, D6};
    use crate::traits::{Roll, RollMut};

    #[test]
    fn roll() {
        let roller = RngRoller::from(Rng::with_seed(7194422452970863838));

        let d6 = D6::new();
        assert_eq!(d6.value(), 1);

        let rd = roller.roll(&d6);
        assert_eq!(rd.value(), 3);
    }

    #[test]
    fn roll_mut() {
        let roller = RngRoller::from(Rng::with_seed(7194422452970863838));

        let mut d6 = D6::new();
        assert_eq!(d6.value(), 1);

        roller.roll_mut(&mut d6);
        assert_eq!(d6.value(), 3);
    }
}