reactive_graph_graph/types/properties/
mutability.rs

1use core::fmt;
2use schemars::JsonSchema;
3use serde::Deserialize;
4use serde::Serialize;
5use std::fmt::Display;
6use std::fmt::Formatter;
7
8#[cfg(any(test, feature = "test"))]
9use default_test::DefaultTest;
10#[cfg(any(test, feature = "docs"))]
11use documented::DocumentedVariants;
12#[cfg(any(test, feature = "test"))]
13use rand_derive3::RandGen;
14#[cfg(any(test, feature = "table"))]
15use tabled::Tabled;
16
17/// The mutability of a property.
18#[derive(Clone, Debug, PartialEq, Eq, Hash, Copy, Serialize, Deserialize, JsonSchema)]
19#[serde(rename_all = "lowercase")]
20#[cfg_attr(any(test, feature = "test"), derive(RandGen))]
21#[cfg_attr(any(test, feature = "table"), derive(Tabled))]
22#[cfg_attr(any(test, feature = "docs"), derive(DocumentedVariants))]
23pub enum Mutability {
24    /// The property is mutable.
25    Mutable,
26
27    /// The property is immutable.
28    Immutable,
29}
30
31impl Mutability {
32    pub fn mutable() -> Self {
33        Mutability::Mutable
34    }
35    pub fn immutable() -> Self {
36        Mutability::Immutable
37    }
38}
39
40impl From<&str> for Mutability {
41    fn from(value: &str) -> Self {
42        match value.to_lowercase().as_str() {
43            "mutable" => Self::Mutable,
44            "immutable" => Self::Immutable,
45            _ => Self::Mutable,
46        }
47    }
48}
49
50impl Display for Mutability {
51    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
52        write!(f, "{self:?}")
53    }
54}
55
56#[cfg(any(test, feature = "test"))]
57impl DefaultTest for Mutability {
58    fn default_test() -> Self {
59        Mutability::generate_random()
60    }
61}
62
63#[cfg(test)]
64mod tests {
65    use schemars::schema_for;
66
67    use crate::Mutability;
68    use reactive_graph_utils_test::r_string;
69
70    #[test]
71    fn mutability_should_be_created_using_static_method_call() {
72        assert_eq!(Mutability::Mutable, Mutability::mutable());
73        assert_eq!(Mutability::Immutable, Mutability::immutable());
74    }
75
76    #[test]
77    fn mutability_from_str() {
78        assert_eq!(Mutability::Mutable, Mutability::from("mutable"));
79        assert_eq!(Mutability::Mutable, Mutability::from("Mutable"));
80        assert_eq!(Mutability::Mutable, Mutability::from("MUTABLE"));
81
82        assert_eq!(Mutability::Immutable, Mutability::from("immutable"));
83        assert_eq!(Mutability::Immutable, Mutability::from("Immutable"));
84        assert_eq!(Mutability::Immutable, Mutability::from("IMMUTABLE"));
85
86        // Fallback to String
87        assert_eq!(Mutability::Mutable, Mutability::from(r_string().as_str()));
88    }
89
90    #[test]
91    fn mutability_display() {
92        assert_eq!("Mutable", format!("{}", Mutability::Mutable));
93        assert_eq!("Immutable", format!("{}", Mutability::Immutable));
94    }
95
96    #[test]
97    fn data_type_json_schema() {
98        let schema = schema_for!(Mutability);
99        println!("{}", serde_json::to_string_pretty(&schema).unwrap());
100    }
101}