Struct Notation 

pub struct Notation { /* private fields */ }

A validated dice expression, such as 2d6+3.

Create one by parsing a string or with Notation::try_new.

Examples

use rust_roll::notation::Notation;

let notation: Notation = "2d6+3".parse().unwrap();

assert_eq!(notation.count(), 2);
assert_eq!(notation.sides(), 6);
assert!(notation.modifier().is_some());

Implementations

impl Notation

pub fn try_new( count: u32, sides: u32, modifier: Option<Modifier>, ) -> Result<Self, NotationError>

Creates a notation, checking that count and sides are within bounds.

Errors

Returns NotationError::Zero if count or sides is zero, or NotationError::NumberTooLarge if either exceeds MAX_VALUE.

Examples

use rust_roll::notation::Notation;

let notation = Notation::try_new(2, 6, None).unwrap();
assert_eq!(notation.count(), 2);

pub fn count(self) -> u32

The number of dice to roll.

pub fn sides(self) -> u32

The number of sides of each die.

pub fn modifier(self) -> Option<Modifier>

The modifier to apply to the total, if any.

pub fn d20(modifier: Option<Modifier>) -> Notation

A single d20 with an optional modifier: the default roll for advantage and disadvantage.

Examples

use rust_roll::notation::Notation;

let notation = Notation::d20(None);
assert_eq!((notation.count(), notation.sides()), (1, 20));

pub fn critical(self) -> Notation

Returns the notation for a critical hit, following the D&D 5e (2014) rules: the number of dice is doubled, while the sides and modifier are unchanged, so the modifier is still applied only once.

The doubled count may exceed MAX_VALUE: a critical 1000d6 becomes 2000d6. This is deliberate, as capping it would change the rule.

Examples

use rust_roll::notation::Notation;

let notation: Notation = "1d8+2".parse().unwrap();
let critical = notation.critical();

assert_eq!(critical.count(), 2);
assert_eq!(critical.modifier(), notation.modifier());

Trait Implementations

impl Clone for Notation

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Notation

impl Debug for Notation

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

Formats the value using the given formatter.

impl Display for Notation

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

Formats the value using the given formatter.

impl Eq for Notation

impl FromStr for Notation

type Err = NotationError

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 for Notation

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Notation