Struct tyche::dice::roller::Iter

pub struct Iter<I: Iterator<Item = u8>>(/* private fields */);

Generates rolls from an iterator of values. Mainly useful for testing purposes.

Examples

use tyche::dice::{roller::{Iter as IterRoller, Roller}, Dice, DieRoll};

let mut roller = IterRoller::new(vec![1, 2, 3, 4, 10]);
let dice = Dice::new(5, 6);
assert_eq!(
	roller.roll(&dice, true)?.rolls,
	vec![DieRoll::new(1), DieRoll::new(2), DieRoll::new(3), DieRoll::new(4), DieRoll::new(10)]
);

Implementations

impl<I: Iterator<Item = u8>> Iter<I>

pub fn can_roll(&mut self) -> bool

Checks whether the iterator still has values available.

pub fn new(iter: impl IntoIterator<IntoIter = I>) -> Self

Creates a new roller that uses the given iterator to provide roll values.

Trait Implementations

impl<I: Clone + Iterator<Item = u8>> Clone for Iter<I>

fn clone(&self) -> Iter<I>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<I: Debug + Iterator<Item = u8>> Debug for Iter<I>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<I: Iterator<Item = u8>> Roller for Iter<I>

fn roll_die(&mut self, _sides: u8) -> DieRoll

Rolls a die with the value from the next iteration.

Panics

If the iterator has finished, this will panic.

fn roll<'d, 'r>( &mut self, dice: &'d Dice, apply_mods: bool ) -> Result<Rolled<'r>, Error>

where Self: Sized, 'd: 'r,

Rolls a set of dice and optionally applies all of its modifiers to the rolls.