fav_core 0.0.3

Fav's core crate; A collection of traits.
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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238

//! Status of resource

use crate::res::{Res, Set, Sets};
use bitflags::bitflags;
#[cfg(feature = "derive")]
pub use fav_derive::Status;

/// Making it able to manage the status
/// # Example
/// ```
/// # #[path = "test_utils/mod.rs"]
/// # mod test_utils;
/// # use test_utils::data::StatusTest;
/// # use fav_core::status::{StatusFlags, Status};
/// impl Status for StatusTest {
///     fn status(&self) -> i32 {
///         self.status
///     }
///     fn status_mut(&mut self) -> &mut i32 {
///         &mut self.status
///     }
/// }
/// ```
pub trait Status {
    /// return status bits
    fn status(&self) -> i32;
    /// return mutable status bits
    fn status_mut(&mut self) -> &mut i32;
    /// return Statusflags
    fn status_flags(&self) -> StatusFlags {
        StatusFlags::from_bits_retain(self.status())
    }
    /// check whether bits in provided StatusFlags all set
    fn check_status(&self, status: StatusFlags) -> bool {
        self.status_flags().contains(status)
    }
    /// set StatusFlags
    fn set_status(&mut self, status: StatusFlags) {
        *self.status_mut() = status.bits();
    }
    /// set bit of provided StatusFlags
    fn on_status(&mut self, status: StatusFlags) {
        self.set_status(self.status_flags() | status);
    }
    /// unset bit of provided StatusFlags
    fn off_status(&mut self, status: StatusFlags) {
        self.set_status(self.status_flags() - status);
    }
}

bitflags! {
    #[allow(missing_docs)]
    #[derive(Clone, Copy)]
    pub struct StatusFlags: i32 {
        #[allow(missing_docs)]
        const FETCHED = 0b00001;
        #[allow(missing_docs)]
        const TRACK = 0b00010;
        #[allow(missing_docs)]
        const SAVED = 0b00100;
        #[allow(missing_docs)]
        const FAV = 0b01000;
        #[allow(missing_docs)]
        const EXPIRED = 0b10000;
    }
}

/// Status Extension for [`Sets`]
/// # Example
/// ```
/// # #[path = "test_utils/mod.rs"]
/// # mod test_utils;
/// # use test_utils::data::{TestSet, TestRes};
/// use fav_core::status::{Status, SetStatusExt, StatusFlags};
/// let mut res_set = TestSet::default();
/// res_set.set.push(TestRes::default());
/// let res_set = res_set.with_res_status_on(StatusFlags::FETCHED);
/// assert!(res_set.set[0].check_status(StatusFlags::FETCHED));
/// ```
pub trait SetsStatusExt: Sets
where
    Self::Set: Status,
{
    /// turn on StatusFlags to all resources
    fn on_set_status(&mut self, status: StatusFlags) {
        self.iter_mut().for_each(|s| s.on_status(status));
    }

    /// set StatusFlags to all resources
    fn off_set_status(&mut self, status: StatusFlags) {
        self.iter_mut().for_each(|s| s.off_status(status));
    }

    /// set StatusFlags to all resources
    fn set_set_status(&mut self, status: StatusFlags) {
        self.iter_mut().for_each(|s| s.set_status(status));
    }

    /// turn on StatusFlags to all resources from old
    fn with_set_status_on(mut self, status: StatusFlags) -> Self
    where
        Self: Sized,
    {
        self.iter_mut().for_each(|s| s.on_status(status));
        self
    }

    /// set StatusFlags to all resources from old
    fn with_set_status_set(mut self, status: StatusFlags) -> Self
    where
        Self: Sized,
    {
        self.iter_mut().for_each(|s| s.set_status(status));
        self
    }
}

impl<T> SetsStatusExt for T
where
    T: Sets,
    T::Set: Status,
{
}

/// Status Extension for [`Set`]
/// # Example
/// ```
/// # #[path = "test_utils/mod.rs"]
/// # mod test_utils;
/// # use test_utils::data::{TestSet, TestRes};
/// use fav_core::status::{Status, SetStatusExt, StatusFlags};
/// let mut res_set = TestSet::default();
/// res_set.set.push(TestRes::default());
/// let res_set = res_set.with_res_status_on(StatusFlags::FETCHED);
/// assert!(res_set.set[0].check_status(StatusFlags::FETCHED));
/// ```
pub trait SetStatusExt: Set {
    /// turn on StatusFlags to all resources
    fn on_res_status(&mut self, status: StatusFlags) {
        self.iter_mut().for_each(|r| r.on_status(status));
    }

    /// set StatusFlags to all resources
    fn off_res_status(&mut self, status: StatusFlags) {
        self.iter_mut().for_each(|r| r.off_status(status));
    }

    /// set StatusFlags to all resources
    fn set_res_status(&mut self, status: StatusFlags) {
        self.iter_mut().for_each(|r| r.set_status(status));
    }

    /// turn on StatusFlags to all resources from old
    fn with_res_status_on(mut self, status: StatusFlags) -> Self
    where
        Self: Sized,
    {
        self.iter_mut().for_each(|r| r.on_status(status));
        self
    }

    /// set StatusFlags to all resources from old
    fn with_res_status_set(mut self, status: StatusFlags) -> Self
    where
        Self: Sized,
    {
        self.iter_mut().for_each(|r| r.set_status(status));
        self
    }
}

impl<S> SetStatusExt for S where S: Set {}

/// Status Extension for [`Res`]
/// # Example
/// ```
/// # #[path = "test_utils/mod.rs"]
/// # mod test_utils;
/// # use test_utils::data::TestRes;
/// use fav_core::status::{Status, ResStatusExt, StatusFlags};
/// let res = TestRes::default().with_status_on(StatusFlags::FETCHED);
/// assert!(res.check_status(StatusFlags::FETCHED));
/// ```
pub trait ResStatusExt: Res + Status + Sized {
    /// turn on StatusFlags to all resources
    fn with_status_on(mut self, status: StatusFlags) -> Self {
        self.on_status(status);
        self
    }

    /// set StatusFlags to all resources
    fn with_status_set(mut self, status: StatusFlags) -> Self {
        self.set_status(status);
        self
    }
}

impl<R> ResStatusExt for R where R: Res + Status + Sized {}

impl From<i32> for StatusFlags {
    fn from(value: i32) -> Self {
        StatusFlags::from_bits_retain(value)
    }
}

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

    #[derive(Status, Default)]
    struct StatusTest {
        status: i32,
    }

    #[test]
    fn status_flags_test() {
        let mut status = StatusFlags::empty();
        status.insert(StatusFlags::FETCHED);
        assert!(status.intersects(StatusFlags::FETCHED));
        assert_eq!(status.bits(), 1);
        status.insert(StatusFlags::TRACK);
        assert_eq!(status.bits(), 3);
    }

    #[test]
    fn status_test() {
        let mut status = StatusTest::default();
        status.on_status(StatusFlags::FETCHED);
        assert!(status.check_status(StatusFlags::FETCHED));
        status.off_status(StatusFlags::FETCHED);
        assert!(!status.check_status(StatusFlags::FETCHED));
        status.on_status(StatusFlags::FETCHED);
        status.on_status(StatusFlags::SAVED);
        assert!(status.check_status(StatusFlags::FETCHED));
        assert!(status.check_status(StatusFlags::SAVED));
    }
}