Function roll_range

Source
pub fn roll_range<R>(rng: &mut R, range: RangeInclusive<i32>) -> RollingRecord
where R: Rng + ?Sized,
Expand description

Generate a value within the specified range, using the same algorithm as the evaluator. If the range is empty (i.e., end<start), then the result is 0.

§Parameters

  • rng: The pseudo-random number generator.
  • range: The range of values to generate.

§Returns

The resultant rolling record.

§Examples

Generate a value within the range 1..=6:

let rolling_record = roll_range(&mut rng(), 1..=6);
assert_eq!(rolling_record.results.len(), 1);
assert!(rolling_record.results[0] >= 1 && rolling_record.results[0] <= 6);

Use an empty range:

let rolling_record = roll_range(&mut rng(), 6..=1);
assert_eq!(rolling_record.results.len(), 1);
assert_eq!(rolling_record.results[0], 0);