Struct caith::RollResult

pub struct RollResult { /* fields omitted */ }

A RollResult contains either a single roll result, or if the roll is repeated, a list of the same roll different results. And a reason if needed.

Implementations

impl RollResult

pub fn new_single(r: SingleRollResult) -> Self

Create a RollResult with only one single roll

pub fn new_repeated(v: Vec<SingleRollResult>, total: Option<i64>) -> Self

Create a RollResult with a repeated roll results

pub fn add_reason(&mut self, reason: String)

Add a comment to the result

pub fn get_reason(&self) -> Option<&String>

Get the comment, if any

pub fn get_result(&self) -> &RollResultType

Return the result

pub fn as_single(&self) -> Option<&SingleRollResult>

If the result is a single roll, it will return it

pub fn as_repeated(&self) -> Option<&RepeatedRollResult>

If the result is a repeated roll, it will return it

Trait Implementations

impl Clone for RollResult

fn clone(&self) -> RollResult

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RollResult

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

Formats the value using the given formatter.

impl Display for RollResult

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

Formats the value using the given formatter.