Enum tyche::dice::Error

#[non_exhaustive]
pub enum Error {
    Overflow(Rolled<'static>),
    InfiniteRolls(Dice),
    UnknownCondition(String),
}

An error resulting from a dice operation

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Overflow(Rolled<'static>)

There was an integer overflow when performing mathematical operations on roll values. This normally should not ever happen given the types used for die counts, sides, and totals.

InfiniteRolls(Dice)

Rolling the dice specified would result in infinite rolls.

Examples

use tyche::dice::{roller::{FastRand as FastRandRoller, Roller}, Dice, Error};

let dice = Dice::builder().count(4).sides(1).explode(None, true).build();
assert!(matches!(FastRandRoller::default().roll(&dice, true), Err(Error::InfiniteRolls(..))));

UnknownCondition(String)

The provided symbol doesn’t match to a known condition.

Examples

use tyche::dice::{modifier::Condition, Error};

let cond = Condition::from_symbol_and_val("!", 4);
assert!(matches!(cond, Err(Error::UnknownCondition(..))));

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type based access to context intended for error reports.