rollo 0.13.6

A Rust-based multiplayer framework.
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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171

use crossbeam::atomic::AtomicCell;
use std::time::Duration;

/// # Interval Manager
/// ## Usage
/// ```rust, no_run
/// use rollo::game::{IntervalExecutor, IntervalMgr};
/// use std::time::Duration;
/// use std::sync::Arc;
///
/// let interval_mgr = IntervalMgr::new(Duration::from_millis(100));
/// let battleground_mgr = Arc::new(BattlegroundMgr);
/// interval_mgr.update(100, &*battleground_mgr, Arc::clone(&battleground_mgr));
///
/// struct BattlegroundMgr;
///
/// impl IntervalExecutor for BattlegroundMgr {
///     type Container = Arc<Self>;
///    
///     fn on_update(&self, diff: i64, _container: Self::Container) {
///     }
/// }
/// ```
#[derive(Debug)]
pub struct IntervalMgr {
    current: AtomicCell<i64>,
    interval: i64,
}

impl IntervalMgr {
    /// ## Create the interval Timer
    /// ### Examples
    /// ```rust, no_run
    /// use rollo::game::IntervalMgr;
    /// use std::time::Duration;
    ///
    /// let interval_timer = IntervalMgr::new(Duration::from_millis(50));
    /// ```
    pub fn new(interval: Duration) -> Self {
        Self {
            current: AtomicCell::new(0),
            interval: interval.as_millis() as i64,
        }
    }

    /// ## Update and executes if time passed
    /// ### Examples
    /// ```rust, no_run
    /// use rollo::game::{IntervalExecutor, IntervalMgr};
    /// use std::time::Duration;
    /// use std::sync::Arc;
    ///
    /// let interval_mgr = IntervalMgr::new(Duration::from_millis(100));
    /// let battleground_mgr = Arc::new(BattlegroundMgr);
    /// interval_mgr.update(100, &*battleground_mgr, Arc::clone(&battleground_mgr));
    ///
    /// struct BattlegroundMgr;
    ///
    /// impl IntervalExecutor for BattlegroundMgr {
    ///     type Container = Arc<Self>;
    ///    
    ///     fn on_update(&self, diff: i64, _container: Self::Container) {
    ///         assert!(diff >= 50)
    ///     }
    /// }
    /// ```
    pub fn update<T>(&self, diff: i64, object: &T, container: T::Container)
    where
        T: IntervalExecutor,
    {
        if self.current.fetch_update(|f| Some(f + diff)).is_err() {
            return;
        }

        if !self.is_passed() {
            return;
        }

        let diff = self.current.load();

        object.on_update(diff, container);

        self.reset();
    }

    fn is_passed(&self) -> bool {
        self.current.load() >= self.interval
    }

    fn reset(&self) {
        let current = self.current.load();
        if current >= self.interval {
            while self
                .current
                .fetch_update(|x| Some(x % self.interval))
                .is_err()
            {}
        }
    }
}

/// Interval Executor
pub trait IntervalExecutor {
    type Container;
    /// When event is executed.
    fn on_update(&self, _diff: i64, container: Self::Container);
}

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

    #[test]
    fn test_update() {
        let timer = IntervalMgr::new(Duration::from_millis(50));
        let bu = TestW;

        timer.update(25, &bu, None);
        assert_eq!(timer.current.load(), 25);

        timer.update(30, &bu, None);
        assert_eq!(5, timer.current.load());

        timer.update(20, &bu, None);
        assert_eq!(25, timer.current.load());

        timer.update(0, &bu, None);
        assert_eq!(25, timer.current.load());

        timer.update(15, &bu, None);
        assert_eq!(40, timer.current.load());

        timer.update(10, &bu, None);
        assert_eq!(0, timer.current.load());
    }

    #[test]
    fn test_reset() {
        let timer = IntervalMgr::new(Duration::from_millis(25));
        timer.current.store(30);
        timer.reset();
        assert_eq!(timer.current.load(), 5);
    }

    #[test]
    fn test_is_passed() {
        let timer = IntervalMgr::new(Duration::from_millis(25));

        timer.current.store(20);
        assert!(!timer.is_passed());

        timer.current.store(25);
        assert!(timer.is_passed());

        timer.current.store(15);
        assert!(!timer.is_passed());

        timer.current.store(0);
        assert!(!timer.is_passed());
    }

    struct TestW;

    impl IntervalExecutor for TestW {
        type Container = Option<u8>;

        fn on_update(&self, diff: i64, _container: Self::Container) {
            assert!(diff >= 50)
        }
    }
}