Struct critfail::Check

pub struct Check { /* fields omitted */ }

An ability check - roll a d20, potentially with modifiers or advantage.

use critfail::{RollExpression, Check};

let check = Check::new("r+4").unwrap();

let outcome = check.roll();

print!("{}", outcome);   // Prints something like "16"
print!("{:?}", outcome); // Prints something like "(12)+4"

Implementations

impl Check

pub fn roll_with_advantage(&self, adv: AdvState) -> CheckOutcome

Roll this check using adv to override the advantage state.

use critfail::{RollExpression, Check, AdvState};
let check = Check::new("r+3").unwrap();

check.roll(); // Roll without advantage
check.roll_with_advantage(AdvState::Advantage); // Roll with advantage
check.roll_with_advantage(AdvState::Neutral); // Roll without advantage
check.roll_with_advantage(AdvState::Disadvantage); // Roll with disadvantage

Trait Implementations

impl Clone for Check

fn clone(&self) -> Check

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Check

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

Formats the value using the given formatter.

impl From<Check> for Roll

fn from(check: Check) -> Self

Performs the conversion.

impl FromStr for Check

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq<Check> for Check

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

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

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

This method tests for !=.

impl RollExpression for Check

type Outcome = CheckOutcome

The roll result type should implement both Display and Debug. Display should print out a consise result for the roll, and Debug should print out the details (eg the value for each rolled die).

fn roll(&self) -> Self::Outcome

Roll the dice and return an outcome.

fn new(expression: &str) -> Result<Self, ParseError>

Create a new roll expression by parsing the given string.

impl StructuralPartialEq for Check