Struct Builder

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

Builds Dice with a fluent interface.

Examples

Basic dice

use tyche::Dice;

let dice = Dice::builder().count(2).sides(6).build();
assert_eq!(dice, Dice::new(2, 6));

Single modifier

use tyche::dice::{Dice, Modifier};

let dice = Dice::builder().count(6).sides(8).explode(None, true).build();
assert_eq!(
	dice,
	Dice {
		count: 6,
		sides: 8,
		modifiers: vec![Modifier::Explode {
			cond: None,
			recurse: true,
		}],
	},
);

Multiple modifiers

use tyche::dice::{modifier::{Condition, Modifier}, Dice};

let dice = Dice::builder()
	.count(6)
	.sides(8)
	.reroll(Condition::Eq(1), false)
	.keep_high(4)
	.build();
assert_eq!(
	dice,
	Dice {
		count: 6,
		sides: 8,
		modifiers: vec![
			Modifier::Reroll {
				cond: Condition::Eq(1),
				recurse: false
			},
			Modifier::KeepHigh(4),
		],
	},
);

Implementations

impl Builder

pub const fn count(self, count: u8) -> Self

Sets the number of dice to roll.

pub const fn sides(self, sides: u8) -> Self

Sets the number of sides per die.

pub fn reroll(self, cond: Condition, recurse: bool) -> Self

Adds a reroll modifier to the dice.

pub fn explode(self, cond: Option<Condition>, recurse: bool) -> Self

Adds an exploding modifier to the dice.

pub fn keep_high(self, count: u8) -> Self

Adds a keep highest modifier to the dice.

pub fn keep_low(self, count: u8) -> Self

Adds a keep lowest modifier to the dice.

pub fn min(self, min: u8) -> Self

Adds a minimum modifier to the dice.

pub fn max(self, max: u8) -> Self

Adds a maximum modifier to the dice.

pub fn build(self) -> Dice

Finalizes the dice.

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Builder

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

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.