fav_core 0.0.1-alpha7

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

//! Status of resource
#![allow(missing_docs)]

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) -> StatusFlags {
///         self.status.into()
///     }
///
///     fn check_status(&self, status: StatusFlags) -> bool {
///         self.status & status.bits() != 0
///     }
///
///
///     fn set_status(&mut self, status: StatusFlags) {
///         self.status = status.bits();
///     }
///
///     fn on_status(&mut self, status: StatusFlags) {
///         self.status |= status.bits();
///     }
///
///     fn off_status(&mut self, status: StatusFlags) {
///         self.status &= !status.bits();
///     }
/// }
/// ```
pub trait Status {
    /// return StatusFlags
    fn status(&self) -> StatusFlags;
    /// check the StatusFlags
    fn check_status(&self, status: StatusFlags) -> bool;
    /// set StatusFlags
    fn set_status(&mut self, status: StatusFlags);
    /// mark provided StatusFlags 1
    fn on_status(&mut self, status: StatusFlags);
    /// mark provided StatusFlags 0
    fn off_status(&mut self, status: StatusFlags);
}

bitflags! {
    pub struct StatusFlags: i32 {
        const FETCHED = 0b00001;
        const TRACK = 0b00010;
        const SAVED = 0b00100;
        const FAV = 0b01000;
        const EXPIRED = 0b10000;
    }
}

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));
    }
}