Struct caith::Roller

pub struct Roller(_);

An object holding the query.

It has no advantage compare to free function that would take &str as parameter (like previous version) but it provides a stable API for the day pest can have a Send type as the parse result.

see Pest’s issue and Forum topic

Implementations

impl Roller

pub fn new(input: &str) -> Result<Self>

Store the input

As of version 2.0.0, it always returns Ok(Self).

This is to have a stable API for further optimization where the parsing is done here (so it can fail) and saved, see Roller documentation above.

pub fn roll(&self) -> Result<RollResult>

Evaluate and roll the dices with default Rng source (rand::thread_rng())

pub fn roll_with<RNG: Rng>(&self, rng: &mut RNG) -> Result<RollResult>

Evaluate and roll the dices with provided rng source

pub fn roll_with_source<RNG: DiceRollSource>(
    &self,
    rng: &mut RNG
) -> Result<RollResult>

Evaluate and roll the dice with provided dice roll source

pub fn dices(&self) -> Result<Dices<'_>>

Get an iterator on the dices in the expression

Examples

use caith::Roller;

let r = Roller::new("1d6 + 1d4 + 1d10 + 1d20").unwrap();
assert_eq!(vec!["1d6", "1d4", "1d10", "1d20"], r.dices().expect("Error on parse").collect::<Vec<_>>());

pub fn as_str(&self) -> &str

Give back the query string

pub fn trim_reason(&mut self)

Removes the reason from the Roller

Trait Implementations

impl Clone for Roller

fn clone(&self) -> Roller

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Roller

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

Formats the value using the given formatter.