Struct Dice

pub struct Dice {
    pub count: u8,
    pub sides: u8,
    pub modifiers: Vec<Modifier>,
}

A set of one or more rollable dice with a specific number of sides, along with a collection of modifiers to apply to any resulting rolls from them.

Fields

count: u8

Number of dice to roll

sides: u8

Number of sides for each die

modifiers: Vec<Modifier>

Modifiers to automatically apply to rolls from this set of dice

Implementations

impl Dice

pub const fn plain(&self) -> Self

Creates a new set of dice matching this one but without any modifiers.

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

Creates a new set of dice with a given count and number of sides.

pub fn builder() -> Builder

Creates a new dice builder.

Trait Implementations

impl Clone for Dice

fn clone(&self) -> Dice

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Dice

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

Formats the value using the given formatter.

impl Default for Dice

fn default() -> Self

Creates the default dice (1d20).

impl Display for Dice

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

Formats the value using the given formatter.

impl FromStr for Dice

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl GenParser<Dice> for Dice

fn parser<'src>() -> impl Parser<'src, &'src str, Self, Err<Rich<'src, char>>> + Copy

Generates a parser for this type that expects end of input. Requires the parse feature (enabled by default).

fn part_parser<'src>() -> impl Parser<'src, &'src str, Self, Err<Rich<'src, char>>> + Copy

Generates a parser for this type that parses up to the end of valid input. Requires the parse feature (enabled by default).

impl Hash for Dice

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Dice

fn eq(&self, other: &Dice) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Dice

impl StructuralPartialEq for Dice