rollr 0.2.0

A lightweight CLI tool and Rust library to roll RPG dice (e.g. 2D20) or flip a coin.
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

use rand::Rng;

/// Simulates rolling a given number of dice with a specified number of sides.
///
/// # Arguments
///
/// * `count` - The number of dice to roll.
/// * `dice_sides` - The number of sides on each die.
///
/// # Returns
///
/// A vector of integers representing the result of each individual die roll.
pub fn throw_dices(count: u16, dice_sides: u16) -> Vec<u16> {
  let mut rng = rand::rng();
  (0..count).map(|_| rng.random_range(1..=dice_sides)).collect()
}

/// Simulates flipping a coin.
///
/// # Returns
///
/// * `true` for heads (Pile).
/// * `false` for tails (Face).
pub fn flip_coin() -> bool {
  rand::random()
}

#[test]
fn test_throw_dices() {
  let results = throw_dices(2, 6);
  assert_eq!(results.len(), 2);
  for result in results {
    assert!(result >= 1 && result <= 6);
  }
}

#[test]
fn test_flip_coin() {
  let result = flip_coin();
  assert!(result == true || result == false);
}