Enum die_parser::RollError

pub enum RollError {
    DieTypeInvalid,
    DiceExceedLimit,
    NoDiceToRoll,
    ParsingError,
}

The different types of errors that may occur trying to construct a Roll from a given input string.

Variants

DieTypeInvalid

Signifies that the inputted die type did not match any of the valid types.

Valid die types are: d2, d4, d6, d8, d10, d12, d20, d100

Example

use die_parser::{Roll, RollError};

let invalid_roll = Roll::parse_roll("1d50");
assert_eq!(invalid_roll, Err(RollError::DieTypeInvalid));

DiceExceedLimit

Signifies that the requested amount of dice exceeded the set limit.

Example

use die_parser::{Roll, RollError};

let invalid_roll = Roll::parse_roll("9001d20");
assert_eq!(invalid_roll, Err(RollError::DiceExceedLimit));

NoDiceToRoll

Signifies that the requested amount of dice was less than 1.

Example

use die_parser::{Roll, RollError};

let invalid_roll = Roll::parse_roll("0d20");
assert_eq!(invalid_roll, Err(RollError::NoDiceToRoll));

ParsingError

Signifies that the input string was malformed.

Example

use die_parser::{Roll, RollError};

let invalid_roll = Roll::parse_roll("4invalid_charactersd20+5");
assert_eq!(invalid_roll, Err(RollError::ParsingError));

Trait Implementations

impl Debug for RollError

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

Formats the value using the given formatter.

impl Display for RollError

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

Formats the value using the given formatter.

impl Error for RollError

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

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

fn backtrace(&self) -> Option<&Backtrace>

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

Returns a stack backtrace, if available, of where this error occurred.

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

impl PartialEq<RollError> for RollError

fn eq(&self, other: &RollError) -> 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 !=.

impl StructuralPartialEq for RollError