Struct FastRand

pub struct FastRand(/* private fields */);

Generates rolls with random values using [fastrand]. Requires the fastrand feature (enabled by default).

Examples

Default fastrand roller

use tyche::dice::{roller::{FastRand as FastRandRoller, Roller}, Dice};

let mut roller = FastRandRoller::default();

let dice = Dice::new(4, 6);
let _ = roller.roll(&dice, true)?;
let _ = roller.roll(&dice, true)?;

Manually seeded fastrand roller

use tyche::dice::{roller::{FastRand as FastRandRoller, Roller}, Dice};

let mut roller = FastRandRoller::with_seed(0x750c38d574400);

let dice = Dice::new(4, 6);
let _ = roller.roll(&dice, true)?;
let _ = roller.roll(&dice, true)?;

Custom fastrand roller

use tyche::dice::{roller::{FastRand as FastRandRoller, Roller}, Dice};
use fastrand::Rng;

let rng = Rng::with_seed(0x750c38d574400);
let mut roller = FastRandRoller::new(rng);

let dice = Dice::new(4, 6);
let _ = roller.roll(&dice, true)?;
let _ = roller.roll(&dice, true)?;

Implementations

impl FastRand

pub const fn new(rng: Rng) -> Self

Creates a new fastrand roller that uses the given RNG instance to generate rolls.

pub fn with_seed(seed: u64) -> Self

Creates a new fastrand roller that uses a pre-seeded RNG instance to generate rolls.

Trait Implementations

impl Clone for FastRand

fn clone(&self) -> FastRand

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FastRand

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

Formats the value using the given formatter.

impl Default for FastRand

fn default() -> FastRand

Returns the “default value” for a type.

impl Roller for FastRand

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

Rolls a single die using the [fastrand::Rng] the roller was created with.

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.