concision-core 0.3.1

this crate implements the core modules for the concision framework
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

/*
    appellation: gsw <module>
    authors: @FL03
*/

#[allow(unused_macros)]
/// [`get!`] is a macro used to generate getter methods for a struct's fields.
macro_rules! get {
    ($($field:ident: $T:ty),* $(,)?) => {
        paste::paste! {
            $(
                /// returns an immutable reference to the field
                pub const fn $field(&self) -> $T {
                    self.$field
                }
                /// return a mutable reference to the field
                pub const fn [<$field _mut>](&mut self) -> &mut $T {
                    &mut self.$field
                }
            )*
        }
    };
    ($($field:ident: &$T:ty),* $(,)?) => {
        paste::paste! {
            $(
                /// returns an immutable reference to the field
                pub const fn $field(&self) -> &$T {
                    &self.$field
                }
                /// return a mutable reference to the field
                pub const fn [<$field _mut>](&mut self) -> &mut $T {
                    &mut self.$field
                }
            )*
        }
    };
}

#[allow(unused_macros)]
/// [`set_with!`] is a macro used to generate `set_` and `with_` methods for a struct's fields.
///
/// ```ignore
/// #[derive(Default)]
/// pub struct Something<T> {
///     field1: T,
///     field2: u8,
/// }
///
/// impl<T> Something<T> {
///     set_with! {
///         field1: T,
///         field2: u8,
///     }
/// }
///
/// let mut something = Something::<f32>::default().with_field1(core::f32::consts::PI);
/// something.set_field2(42);
/// ```
macro_rules! set_with {
    ($($field:ident: $F:ty),* $(,)?) => {
        paste::paste! {
            $(
                /// update the current value of the field and return a mutable reference to self
                pub fn [<set_ $field>](&mut self, value: $T) {
                    self.$field = value
                }
                /// consume the current instance to create another with the given value
                pub fn [<with_ $field>](self, $field: $T) -> Self {
                    Self {
                        $field,
                        ..self
                    }
                }
            )*
        }

    };
}