armc 1.4.5

Armc is a rust implementation that facilitates Mutex access to variables.
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

/// This macro will create an ARMC wrapper in a struct defined in the macro's scope while retaining the macro's name.
///
/// # Example
///
/// ```
/// #[macro_use]
/// extern crate my_crate;
///
/// object!(pub MyStruct {
///     foo: u32,
///     bar: String,
/// });
///
/// let my_struct = MyStruct::new(42, "hello".to_string());
/// ```
#[macro_export]
macro_rules! object {
    ($vis:vis $name:ident { $($field:ident : $type:ty),* }) => {
        struct Base {
            $(pub $field: $type),*
        }

        #[derive(Clone,PartialEq)]
        $vis struct $name {
            base : Armc<Base>,
        }

    };
}

/// This macro will create an ARMC wrapper in a struct defined in the macro's scope while retaining the macro's name with a constructor.
///
/// # Example
///
/// ```
/// #[macro_use]
/// extern crate my_crate;
/// object_with_new!(MyStruct { foo: u32, bar: String, });
/// let my_struct = MyStruct::new(42, "hello".to_string());
///```

#[macro_export]
macro_rules! object_with_new {
    ($vis:vis $name:ident { $($field:ident : $type:ty),* }) => {
        struct Base {
            $(pub $field: $type),*
        }

        #[derive(Clone,PartialEq)]
        $vis struct $name {
            base : Armc<Base>,
        }
        /// A constructor that creates a new instance of the struct with the given field values.
        ///
        /// # Arguments
        ///
        /// * `$($field: $type),*` - A list of field values to initialize the struct with.
        ///
        /// # Example
        ///
        /// ```
        /// # #[macro_use] extern crate my_crate;
        /// let my_struct = MyStruct::new(42, "hello".to_string());
        /// ```
            impl $name {
                pub fn new($($field: $type),*) -> Self {
                    $name {
                        base: Armc::new(Base {
                            $($field: $field),*
                        })
                    }
                }
            }


    };
}

/// This macro expands to a struct with fields wrapped in an ARMC to allow thread-safe mutation and access to those fields via generated getters.
///
/// The generated struct will also have a constructor `new` that takes in the initial values for each field.
///
/// # Example
///
/// ```
/// #[macro_use]
/// extern crate my_crate;
///
/// object_ref_access!(MyStruct {
///     foo: u32,
///     bar: String,
/// });
///
/// let my_struct = MyStruct::new(42, "hello".to_string());
/// let foo_ref = my_struct.foo();
/// ```
#[macro_export]
macro_rules! object_ref_access {
    ($vis:vis $name:ident { $($field:ident : $type:ty),* }) => {
        struct Base {
            $(pub $field: $type),*
        }

        #[derive(Clone,PartialEq)]
        $vis struct $name {
            base : Armc<Base>,
        }
            impl $name {
                pub fn new($($field: $type),*) -> Self {
                    $name {
                        base: Armc::new(Base {
                            $($field: $field),*
                        })
                    }
                }
            $(
                // Generate getter
                pub fn $field(&self) -> &$type {
                    &self.base.$field
                }
            )*
        }


    };
}

/// This macro creates an ARMC wrapper in a struct defined in the macro's scope, along with a new constructor and getter methods for each field, and mutable setter methods for each field with the suffix `_mut`.
///
/// # Example
///
/// ```
///
/// object_mut_access!(MyStruct {
///     foo: u32,
///     bar: String,
/// });
///
/// let mut my_struct = MyStruct::new(42, "hello".to_string());
///
/// assert_eq!(*my_struct.foo(), 42);
///
/// my_struct.foo_mut(13);
/// assert_eq!(*my_struct.foo(), 13);
/// ```
#[macro_export]
macro_rules! object_mut_access {
    ($vis:vis $name:ident { $($field:ident : $type:ty),* }) => {
        struct Base {
            $(pub $field: $type),*
        }

        #[derive(Clone,PartialEq)]
        $vis struct $name {
            base : Armc<Base>,
        }
            impl $name {
                pub fn new($($field: $type),*) -> Self {
                    $name {
                        base: Armc::new(Base {
                            $($field: $field),*
                        })
                    }
                }
            $(
                // Generate getter
                pub fn $field(&self) -> &$type {
                    &self.base.$field
                }
            )*
        }
        use paste::paste;
        paste! {
        impl $name {
            $(
                // Generate mutable setter
                pub fn [<$field _mut>] (&mut self, value: $type) -> &mut Self {
                    self.base.lock().$field = value;
                    self
                }
            )*
        }
        }


    };
}