Struct tiny_die::Die

pub struct Die {
    pub sides: u8,
}

Contains the Die struct and its functions.

Fields

sides: u8

A die has sides, that’s what makes it a die.

Implementations

impl Die

pub fn new(sides: u8) -> Self

Returns a die with sides number of sides.

Arguments

sides - optional; a u8 representing the number of sides on the die

Example

use tiny_die::Die;
let dee_ten = Die::new(10);

pub fn default() -> Self

Returns a die with six sides. If you just need a standard d6, use Die::default().

Example

use tiny_die::Die;
let dee_six = Die::default();

pub fn roll(&self) -> u8

Return a number between 1 and number of sides plus 1. Plus 1 because that’s how gen_range() works baybee.

Example

use tiny_die::Die;
let dee_ten = Die::new(10);
let rolled = dee_ten.roll();

Trait Implementations

impl Display for Die

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

Formats the value using the given formatter.