Struct dice::Die

pub struct Die(_);

A die.

Methods

impl Die

fn minimum(&self) -> i32

Returns the smallest possible result of rolling this die.

fn maximum(&self) -> i32

Returns the largest possible result of rolling this die.

fn average(&self, reroll: Option<Reroll>) -> Ratio

Returns the average result of rolling this die.

fn results(&self) -> impl Iterator<Item = i32>

Returns all the possible results of rolling this die.

fn probabilities(&self, reroll: Option<Reroll>) -> Vec<(i32, Ratio)>

Returns the probabilities of all the possible results of rolling this die.

impl Die

fn new(size: u32) -> Die

Constructs a new Die.

Panics

• size is zero

fn size(&self) -> u32

Returns the size of this die.

fn roll(&self, rng: &mut Rng, reroll: Option<Reroll>) -> DieResult

Rolls this die and returns the result.

Trait Implementations

impl Copy for Die

impl Clone for Die

fn clone(&self) -> Die

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Die

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl PartialEq for Die

fn eq(&self, __arg_0: &Die) -> bool

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

fn ne(&self, __arg_0: &Die) -> bool

This method tests for !=.

impl Eq for Die

impl PartialOrd for Die

fn partial_cmp(&self, __arg_0: &Die) -> Option<Ordering>

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

fn lt(&self, __arg_0: &Die) -> bool

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

fn le(&self, __arg_0: &Die) -> bool

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

fn gt(&self, __arg_0: &Die) -> bool

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

fn ge(&self, __arg_0: &Die) -> bool

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

impl Ord for Die

fn cmp(&self, __arg_0: &Die) -> Ordering

This method returns an Ordering between self and other.

impl Hash for Die

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

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].