scsys-core 0.3.2

core primitives and utilities for the scsys ecosystem
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

/*
    Appellation: gsw <module>
    Contrib: @FL03
*/
/// The `gsw` macro generates getter and setter methods for the fields of a struct. At the
/// moment, the macro can handle any type; for types that implement the [`Copy`] trait, simply
/// drop the `&` to the left of each type.
///
/// **Note**: make sure that
///
/// ### Usage
///
/// ```rust
/// use scsys_core::gsw;
///
/// #[derive(Clone, Debug, Default)]
/// pub struct Sample<T> {
///     pub(crate) a: usize,
///     pub(crate) b: f32,
///     pub(crate) store: Vec<u8>,
///     pub(crate) c:T,
///
/// }
///
/// impl<T> Sample<T> {
///     gsw! {
///         a: usize,
///         b: f32,
///     }
///     gsw! {
///         c: &T,
///         store: &Vec<u8>,
///     }
/// }
///
/// #[test]
/// fn test_sample_gsw_impls() {
///     let mut sample = Sample::<&str>::default().with_a(10).with_store(vec![1, 2, 3]);
///     sample.set_b(3.14).set_c("hello");
///     assert_eq!(sample.a(), 10);
///     assert_eq!(sample.b(), 3.14);
///     assert_eq!(sample.c(), "hello");
///     assert_eq!(sample.store(), &vec![1, 2, 3]);
///     sample.c_mut().push(u8::MAX);
///     assert!(sample.store().last() == Some(&u8::MAX));
/// }
/// ```
#[macro_export]
macro_rules! gsw {
    ($($name:ident: &$T:ty),* $(,)?) => {
        $(
            $crate::gsw!(@get $name: &$T);
            $crate::gsw!(@get_mut $name: $T);
            $crate::gsw!(@setter $name: $T);
        )*
    };
    ($($name:ident: $T:ty),* $(,)?) => {
        $(
            $crate::gsw!(@get $name: $T);
            $crate::gsw!(@get_mut $name: $T);
            $crate::gsw!(@setter $name: $T);
        )*
    };
    (@get $name:ident: &$T:ty) => {
        pub const fn $name(&self) -> &$T {
            &self.$name
        }
    };
    (@get $name:ident: $T:ty) => {
        pub const fn $name(&self) -> $T {
            self.$name
        }
    };
    (@get_mut $name:ident: $T:ty) => {
        paste::paste! {
            pub const fn [<$name _mut>] (&mut self) -> &mut $T {
                &mut self.$name
            }
        }
    };
    (@setter $name:ident: $T:ty) => {
        paste::paste! {
            pub fn [<set_ $name>](&mut self, $name: $T) -> &mut Self {
                self.$name = $name;
                self
            }

            pub fn [<with_ $name>] (self, $name: $T) -> Self {
                Self {
                    $name,
                    ..self
                }
            }
        }
    };
}

#[macro_export]
macro_rules! get_field {
    ($($name:ident: &$T:ty),* $(,)?) => {
        $(
            $crate::gsw!(@get $name: &$T);
            $crate::gsw!(@get_mut $name: $T);
            $crate::gsw!(@setter $name: $T);
        )*
    };
    ($($name:ident: $T:ty),* $(,)?) => {
        $(
            $crate::gsw!(@get $name: $T);
            $crate::gsw!(@get_mut $name: $T);
            $crate::gsw!(@setter $name: $T);
        )*
    };

    (@getter $name:ident: &$T:ty) => {
        pub const fn $name(&self) -> &$T {
            &self.$name
        }
    };
    (@getter $name:ident: $T:ty) => {
        pub const fn $name(&self) -> $T {
            self.$name
        }
    };
    (@get_mut $name:ident: $T:ty) => {
        paste::paste! {
            pub const fn [<$name _mut>] (&mut self) -> &mut $T {
                &mut self.$name
            }
        }
    };
    (@get $name:ident: &$T:ty) => {
        pub const fn $name(&self) -> &$T {
            &self.$name
        }
    };
    (@get $name:ident: $T:ty) => {
        pub const fn $name(&self) -> $T {
            self.$name
        }
    };
}