Struct tyche::dice::DieRoll

#[non_exhaustive]
pub struct DieRoll {
    pub val: u8,
    pub added_by: Option<Modifier>,
    pub dropped_by: Option<Modifier>,
    pub changes: Vec<ValChange>,
}

Single die produced from rolling Dice and optionally applying Modifiers

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

val: u8

Value that was rolled

added_by: Option<Modifier>

Modifier that caused the addition of this die, if any

dropped_by: Option<Modifier>

Modifier that caused the drop of this die, if any

changes: Vec<ValChange>

Modifications that were made to the value of the roll

Implementations

impl DieRoll

pub fn add(&mut self, from: Modifier)

Marks this die roll as added by a given modifier, setting Self::added_by.

Panics

Panics if Self::added_by is already Some.

pub fn drop(&mut self, from: Modifier)

Marks this die roll as dropped by a given modifier, setting Self::dropped_by.

Panics

Panics if Self::dropped_by is already Some.

pub fn change(&mut self, from: Modifier, new_val: u8)

Replaces the die roll’s value and logs the change made.

pub const fn is_original(&self) -> bool

Indicates whether this die roll was part of the original set (not added by a modifier).

pub const fn is_additional(&self) -> bool

Indicates whether this die roll was added as the result of a modifier being applied. This is the direct inverse of DieRoll::is_original().

pub const fn is_dropped(&self) -> bool

Indicates whether this die roll has been dropped by a modifier.

pub const fn is_kept(&self) -> bool

Indicates whether this die roll is being kept (has not been dropped by a modifier). This is the direct inverse of DieRoll::is_dropped().

pub fn is_changed(&self) -> bool

Indicates whether this die roll’s value has been directly changed by a modifier.

pub const fn new(val: u8) -> Self

Creates a new die roll with the given value.

Trait Implementations

impl Clone for DieRoll

fn clone(&self) -> DieRoll

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DieRoll

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

Formats the value using the given formatter.

impl Display for DieRoll

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

Formats the value using the given formatter.

The format of a die roll is simply the plain numeric value of the roll. If the roll was dropped, it is appended with (d).

Examples

use tyche::dice::DieRoll;

let roll = DieRoll::new(4);
assert_eq!(roll.to_string(), "4");

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

let mut roll = DieRoll::new(16);
let kh_mod = Modifier::KeepHigh(1);
roll.drop(kh_mod);
assert_eq!(roll.to_string(), "16 (d)");

impl Ord for DieRoll

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for DieRoll

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for DieRoll

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for DieRoll

impl StructuralPartialEq for DieRoll