Struct ExprResult 

pub struct ExprResult {
    pub total: i32,
    pub rolls: Vec<i32>,
    pub modifier: i32,
}

The result of evaluating a dice expression.

This struct contains the final total, all individual die rolls (with their signs), and the sum of all constant modifiers in the expression.

Fields

• total: The final result after all rolls and modifiers are applied
• rolls: All individual die rolls. Rolls from subtracted expressions are negative.
• modifier: The sum of all constant (non-dice) terms in the expression

Examples

use dice_parser::DiceExpr;

let expr = DiceExpr::parse("2d6+3").unwrap();
let result = expr.roll().unwrap();

// Access the components of the result
println!("Total: {}", result.total);           // e.g., 10
println!("Dice rolls: {:?}", result.rolls);    // e.g., [3, 4]
println!("Modifier: {}", result.modifier);     // 3

// Total equals sum of rolls plus modifier
assert_eq!(result.total, result.rolls.iter().sum::<i32>() + result.modifier);

Subtraction Example

use dice_parser::DiceExpr;

let expr = DiceExpr::parse("10 - 2d6").unwrap();
let result = expr.roll().unwrap();

// Subtracted rolls are negative in the rolls vec
assert_eq!(result.modifier, 10);
assert_eq!(result.rolls.len(), 2);
// Both rolls should be negative
assert!(result.rolls[0] < 0 && result.rolls[1] < 0);

Fields

total: i32

The total result of the expression.

rolls: Vec<i32>

All individual die rolls. Subtracted rolls are negative.

modifier: i32

The sum of all constant modifiers in the expression.

Implementations

impl ExprResult

pub fn new(total: i32, rolls: Vec<i32>, modifier: i32) -> Self

Trait Implementations

impl Add for ExprResult

type Output = ExprResult

The resulting type after applying the + operator.

fn add(self, other: ExprResult) -> Self

Performs the + operation.

impl Clone for ExprResult

fn clone(&self) -> ExprResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExprResult

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

Formats the value using the given formatter.

impl Neg for ExprResult

type Output = ExprResult

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl Sub for ExprResult

type Output = ExprResult

The resulting type after applying the - operator.

fn sub(self, other: ExprResult) -> Self

Performs the - operation.