made-core 0.8.0

Domain core of MADE: entities, value objects, events, ports. No IO.
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
53
54
55
56
57

use serde::{Deserialize, Serialize};

use super::LoopRoundLimit;

/// How long an integrator's loop may go round before it stops itself.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
pub struct LoopLimits {
    #[serde(default, skip_serializing_if = "Option::is_none")]
    max_rounds: Option<LoopRoundLimit>,
    no_progress_rounds: LoopRoundLimit,
}

impl LoopLimits {
    #[must_use]
    pub const fn new(
        max_rounds: Option<LoopRoundLimit>,
        no_progress_rounds: LoopRoundLimit,
    ) -> Self {
        Self {
            max_rounds,
            no_progress_rounds,
        }
    }

    /// A ceiling on rounds, when the caller set one.
    #[must_use]
    pub const fn max_rounds(self) -> Option<LoopRoundLimit> {
        self.max_rounds
    }

    /// How many rounds with nothing new before the loop declares itself stuck.
    #[must_use]
    pub const fn no_progress_rounds(self) -> LoopRoundLimit {
        self.no_progress_rounds
    }
}

impl Default for LoopLimits {
    fn default() -> Self {
        Self {
            max_rounds: None,
            no_progress_rounds: LoopRoundLimit::default_without_progress(),
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn the_default_is_unbounded_rounds_and_three_without_progress() {
        let limits = LoopLimits::default();
        assert!(limits.max_rounds().is_none());
        assert_eq!(limits.no_progress_rounds().value(), 3);
    }
}