Struct mice::FormatOptions

pub struct FormatOptions { /* fields omitted */ }

Formatting options for dice expressions. Necessary for stability of user facing output, which is this library's primary concern.

Default formatting MAY change between patch releases. New public options MUST cause a minor version increment. Changes to the behavior of an existing public option MUST cause a minor version increment.

To get back the old formatting scheme:

let format = MiceFormat::new()
    .total_left()
    .term_commas()
    .term_list_parens()
    .concise();
println!("{}", roll("2d6 + 3")?.format(format));

Methods

impl FormatOptions

pub fn new() -> FormatOptions

Obtain a new FormatOptions object.

pub fn total_right(self) -> Self

The total of an expression will appear on the right hand side of it, = total.

pub fn total_left(self) -> Self

The total of an expression will appear on the left hand side of it, total = .

pub fn no_total(self) -> Self

The total of an expression will not appear. This is the current default.

pub fn concise(self) -> Self

Dice term representations will be (Dice → Total).

pub fn verbose(self) -> Self

Dice term representations will be (Dice → Die1 + Die2 + ...). This is the current default.

pub fn term_commas(self) -> Self

Separate term results with commas. Term1, Term2, ...

pub fn term_pluses(self) -> Self

Separate term results with plus signs. Term1 + Term2 + ... This is the current default.

pub fn dice_parens(self) -> Self

Wrap each dice term result in parentheses. This is the current default.

pub fn no_term_parens(self) -> Self

Don't wrap each dice term result in parentheses.

pub fn term_list_parens(self) -> Self

Wrap entire list of terms in parentheses.

pub fn no_term_list_parens(self) -> Self

Don't wrap entire list of terms in parentheses. This is the current default.

Trait Implementations

impl Default for FormatOptions

fn default() -> Self

Returns the "default value" for a type.

impl Clone for FormatOptions

fn clone(&self) -> FormatOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for FormatOptions

impl Debug for FormatOptions

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

Formats the value using the given formatter.