rdice-core 0.1.0

Reusable dice, tray, expression parsing, rolling, and analysis primitives
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52

//! Persistent dice tray data structures.
//!
//! A tray groups dice into slots so callers can roll the group repeatedly while
//! locking selected slots between rolls.

use super::die::FaceValue;
use serde::{Deserialize, Serialize};

/// A single die slot inside a [`Tray`].
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct TraySlot {
    /// Canonical name of the die assigned to this slot.
    pub die_name: String,
    /// Stable slot identifier within the tray.
    pub slot_id: u32,
    /// Whether rolling the tray should preserve this slot's current value.
    pub locked: bool,
    /// Most recent rolled value for this slot.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub current_value: Option<FaceValue>,
}

/// A named collection of dice slots.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Tray {
    /// Tray name.
    pub name: String,
    /// Slots currently assigned to the tray.
    #[serde(default)]
    pub slots: Vec<TraySlot>,
    /// Next slot identifier to assign.
    ///
    /// Slot identifiers are auto-incrementing and are not reused after a slot is
    /// removed from the tray.
    #[serde(default = "default_next_slot_id")]
    pub next_slot_id: u32,
}

fn default_next_slot_id() -> u32 {
    1
}

impl Tray {
    /// Creates an empty tray with slot identifiers starting at `1`.
    pub fn new(name: String) -> Self {
        Self {
            name,
            slots: Vec::new(),
            next_slot_id: 1,
        }
    }
}