lib_dice 1.0.0

A library for parsing dice rolls
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

//! A library for parcing dice rolls using nom.
//!
//! ## Usage
//! ```
//! extern crate lib_dice;
//! use lib_dice::DiceRoll;
//! use std::str::FromStr;
//!
//! fn main() {
//! 	let roll_1 = lib_dice::roll(1, 8, 0); // 1d8 + 0
//! 	let roll_2 = lib_dice::roll_from_str("2d6 + 7");
//!
//!     let dice = DiceRoll::new(1, 8, 3); // 1d8 + 3
//!     let roll_3 = dice.roll();
//!     let roll_4 = dice.roll_no_bonus();
//! }
//! ```

extern crate nom;
extern crate rand;

use std::str::FromStr;

mod error;
pub use error::DiceFormatError;

mod dice;
pub use dice::DiceRoll;

mod parse;

/// Simulate a random dice roll using the rand crate.
///
/// ## Example
/// ```
/// use lib_dice::roll;
/// let roll_1 = roll(1, 8, 0); // 1d8 + 0
/// let roll_2 = roll(2, 6, 7); // 2d6 + 7
/// ```
pub fn roll(count: usize, dice: u8, bonus: i32) -> i32 {
    DiceRoll { count, dice, bonus }.roll()
}

/// Parse a dice roll from a sting in one of the following formats
///
/// ## Example
/// ```
/// use lib_dice::roll_from_str;
/// let roll_1 = roll_from_str("1d8").unwrap();  // roll a single 8 sided dice
/// let roll_2 = roll_from_str("2d6 + 7").unwrap();  // roll 2 6 sided dice with a +7 bonus
/// ```
///
/// ## Error
///
/// A `lib_dice::DiceFormatError` will be thrown if the dice string is malformed or empty.
pub fn roll_from_str(cmd: &str) -> Result<i32, DiceFormatError> {
    Ok(DiceRoll::from_str(cmd)?.roll())
}

#[test]
fn test_roll() {
    // Roll one dice
    for _ in 0..1000 {
        let r = roll(1, 6, 0);
        assert!(r >= 1);
        assert!(r <= 6);
    }

    // Roll two dice
    for _ in 0..1000 {
        let r = roll(2, 6, 0);
        assert!(r >= 1);
        assert!(r <= 12);
    }

    // Roll with bonus
    for _ in 0..1000 {
        let r = roll(1, 6, 6);
        assert!(r >= 6);
        assert!(r <= 12);
    }
}

#[test]
fn test_roll_from_str() {
    // Roll one dice
    for _ in 0..1000 {
        let r = roll_from_str("1d6").unwrap();
        assert!(r >= 1);
        assert!(r <= 6);
    }

    // Roll two dice
    for _ in 0..1000 {
        let r = roll_from_str("2d6").unwrap();
        assert!(r >= 1);
        assert!(r <= 12);
    }

    // Roll with bonus
    for _ in 0..1000 {
        let r = roll_from_str("1d6+6").unwrap();
        assert!(r >= 6);
        assert!(r <= 12);
    }
}