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
use crate::runtime::msg::Msg;
use derive_more::{From, IntoIterator};

use super::EnvFuture;

type Future = EnvFuture<'static, Msg>;

pub enum EffectFuture {
    Concurrent(Future),
    Sequential(Future),
}

#[derive(From)]
pub enum Effect {
    Msg(Box<Msg>),
    Future(EffectFuture),
}

/// # Examples
///
/// ```
/// use stremio_core::runtime::Effects;
///
/// let none_unchanged = Effects::none().unchanged();
/// let default = Effects::default();
///
/// assert_eq!(default.has_changed, false);
/// assert!(none_unchanged.is_empty());
/// assert!(default.is_empty());
/// assert_eq!(none_unchanged.has_changed, default.has_changed);
/// ```
#[derive(IntoIterator)]
pub struct Effects {
    #[into_iterator(owned)]
    /// The effects to be applied
    effects: Vec<Effect>,
    /// Whether or not the effects are changing something in the [`Model`].
    ///
    /// When `has_changed == true` it will mark the given model field
    /// as changed and add effect for it.
    /// This will trigger a [`RuntimeEvent::NewState`] for the [`Model`]
    /// with all it's changed fields.
    ///
    /// [`Model`]: crate::runtime::Model
    /// [`RuntimeEvent::NewState`]: crate::runtime::RuntimeEvent::NewState
    pub has_changed: bool,
}

impl Effects {
    pub fn none() -> Self {
        Effects {
            effects: vec![],
            has_changed: true,
        }
    }
    pub fn one(effect: Effect) -> Self {
        Effects {
            effects: vec![effect],
            has_changed: true,
        }
    }
    pub fn many(effects: Vec<Effect>) -> Self {
        Effects {
            effects,
            has_changed: true,
        }
    }
    pub fn msg(msg: Msg) -> Self {
        Effects::one(Effect::Msg(Box::new(msg)))
    }
    pub fn future(future: EffectFuture) -> Self {
        Effects::one(Effect::Future(future))
    }
    pub fn msgs(msgs: Vec<Msg>) -> Self {
        Effects::many(msgs.into_iter().map(Box::new).map(Effect::from).collect())
    }
    pub fn futures(futures: Vec<EffectFuture>) -> Self {
        Effects::many(futures.into_iter().map(Effect::from).collect())
    }

    /// mark model as not changed
    pub fn unchanged(mut self) -> Self {
        self.has_changed = false;
        self
    }
    pub fn join(mut self, mut effects: Effects) -> Self {
        self.has_changed = self.has_changed || effects.has_changed;
        self.effects.append(&mut effects.effects);
        self
    }

    /// Returns the amount of effects
    pub fn len(&self) -> usize {
        self.effects.len()
    }

    /// Returns whether there are any effects
    pub fn is_empty(&self) -> bool {
        self.effects.is_empty()
    }
}

impl Default for Effects {
    fn default() -> Self {
        Self::none().unchanged()
    }
}

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

    #[test]
    fn test_effects_defaults() {
        let none_unchanged = Effects::none().unchanged();
        let default = Effects::default();

        assert!(!default.has_changed);
        assert!(none_unchanged.is_empty());
        assert!(default.is_empty());
        assert_eq!(none_unchanged.has_changed, default.has_changed);
    }
}