Struct critfail::CheckOutcome

pub struct CheckOutcome { /* fields omitted */ }

The outcome of a check roll.

This struct is normally constructed as the result of calling roll() on a Check roll expression.

use critfail::{RollExpression, Check, CheckOutcome};

let outcome: CheckOutcome = Check::new("r+1").unwrap().roll();

Implementations

impl CheckOutcome

pub fn score(&self) -> Score

Get the score of a CheckOutcome.

This is the plain numerical score of a roll, without accounting for critial success/failure

use critfail::CheckOutcomeBuilder;

// (20)+4
let critical = CheckOutcomeBuilder::new()
    .check(20)
    .modifier(4)
    .build();

// (16)+4
let normal = CheckOutcomeBuilder::new()
    .check(16)
    .modifier(4)
    .build();
// (1)+4
let fail = CheckOutcomeBuilder::new()
    .check(1)
    .modifier(4)
    .build();

assert_eq!(critical.score(), 24);
assert_eq!(normal.score(), 20);
assert_eq!(fail.score(), 5);

pub fn crit_score(&self) -> CritScore

Get the score of a CheckOutcome that could be a critical success/failure.

use critfail::{CheckOutcomeBuilder, CritScore};

// (20)+4
let critical = CheckOutcomeBuilder::new()
    .check(20)
    .modifier(4)
    .build();

// (16)+4
let normal = CheckOutcomeBuilder::new()
    .check(16)
    .modifier(4)
    .build();
// (1)+4
let fail = CheckOutcomeBuilder::new()
    .check(1)
    .modifier(4)
    .build();

assert_eq!(critical.crit_score(), CritScore::Critical);
assert_eq!(normal.crit_score(), CritScore::Normal(20));
assert_eq!(fail.crit_score(), CritScore::Fail);

Trait Implementations

impl Clone for CheckOutcome

fn clone(&self) -> CheckOutcome

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CheckOutcome

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

Formats the value using the given formatter.

impl Display for CheckOutcome

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

Formats the value using the given formatter.

impl From<CheckOutcome> for RollOutcome

fn from(o: CheckOutcome) -> Self

Performs the conversion.

impl PartialEq<CheckOutcome> for CheckOutcome

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

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

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

This method tests for !=.

impl StructuralPartialEq for CheckOutcome