Struct rng_query::RollResult

pub struct RollResult { /* private fields */ }

Result of a dice roll evaluation

The Display alternate modifier will only print RollResult::total.

Implementations

impl RollResult

pub fn all_dice(&self) -> impl Iterator<Item = (u16, bool)> + '_

Results obtained

The iterator returns a tuple of the value rolled and bool that indicates if the dice is kept or not.

pub fn dice(&self) -> impl Iterator<Item = u16> + '_

Iterator of dice values

This is after keep/drop of high/low

pub fn amount(&self) -> (usize, usize)

Amount of dice

The first element is the original amount and the second the number of dice rolled. This can differ if the roll was exploding.

pub fn sides(&self) -> u16

Sides of the rolled dice

pub fn modifier(&self) -> i32

Modifier applied

pub fn was_exploding(&self) -> bool

If the roll was exploding

pub fn total(&self) -> i32

Total value

Trait Implementations

impl Clone for RollResult

fn clone(&self) -> RollResult

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RollResult

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

Formats the value using the given formatter.

impl Display for RollResult

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

Formats the value using the given formatter.

impl PartialEq<RollResult> for RollResult

fn eq(&self, other: &RollResult) -> 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 Eq for RollResult

impl StructuralEq for RollResult

impl StructuralPartialEq for RollResult