figen 0.2.0

Strongly typed configuration bindings and registries generated from a declarative schema
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
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
use crate::error::Error;
use crate::loader::PropertyLoader;
use crate::BindPath;

pub const MAX_ARRAY_SIZE: usize = 1024;
const MAX_ARRAY_KEY_SIZE_STR: usize = 4;

pub struct BindContext<T, U> {
    pub path: T,
    pub loader: U,
}

impl<T, U> BindContext<T, U>
where
    T: BindPath,
    U: PropertyLoader,
{
    pub fn new(path: T, loader: U) -> Self {
        Self { path, loader }
    }
}

pub trait ConfigBinder<T, U>
where
    Self: Sized,
    T: BindPath,
    U: PropertyLoader,
{
    fn bind(&mut self, path: &mut T, loader: &U) -> crate::error::Result<()>;
}

pub trait ConfigInitializer<T, U>: Sized
where
    T: BindPath,
    U: PropertyLoader,
{
    fn initialize(path: &mut T, loader: &U) -> crate::error::Result<Self>;
}

/// ConfigBinder implementation for [std::string::String] types.
#[cfg(feature = "std")]
impl<T, U> ConfigBinder<T, U> for std::string::String
where
    T: BindPath,
    U: PropertyLoader,
{
    #[cold]
    #[inline(never)]
    fn bind(&mut self, path: &mut T, loader: &U) -> crate::error::Result<()> {
        *self = Self::initialize(path, loader)?;
        Ok(())
    }
}

#[cfg(feature = "std")]
impl<T, U> ConfigInitializer<T, U> for std::string::String
where
    T: BindPath,
    U: PropertyLoader,
{
    #[cold]
    #[inline(never)]
    fn initialize(path: &mut T, loader: &U) -> crate::error::Result<Self> {
        loader.load_str_value(path.current_path()).map(Into::into)
    }
}

/// ConfigBinder implementation for heapless::String.
/// This implementation allows for binding a `heapless::String` to a configuration backend,
/// loading a string value from the backend and storing it in the `heapless::String`.
/// It is designed to work in environments without the standard library, such as embedded systems.
#[cfg(not(feature = "std"))]
impl<const N: usize, T, U> ConfigBinder<T, U> for heapless::String<N>
where
    T: BindPath,
    U: PropertyLoader,
{
    #[cold]
    #[inline(never)]
    fn bind(&mut self, path: &mut T, loader: &U) -> crate::error::Result<()> {
        *self = Self::initialize(path, loader)?;
        Ok(())
    }
}

#[cfg(not(feature = "std"))]
impl<const N: usize, T, U> ConfigInitializer<T, U> for heapless::String<N>
where
    T: BindPath,
    U: PropertyLoader,
{
    #[cold]
    #[inline(never)]
    fn initialize(path: &mut T, loader: &U) -> crate::error::Result<Self> {
        loader.load_str_value(path.current_path()).map(Into::into)
    }
}

pub enum ArrayConfigIndicesMode<'a> {
    ZeroIndexed,
    Custom(&'a [&'a str]),
}

/// Binder for arrays in configuration.
/// This binder allows for binding to an array of items in the configuration backend using either zero-based indexing or custom indices.
/// It supports binding to a fixed-size array of items, where each item can be of any type that implements the `ConfigBinder` trait.
pub struct ArrayConfigBinder<'a, T> {
    mode: ArrayConfigIndicesMode<'a>,
    items: &'a mut [T],
}

pub struct ArrayConfigInitializer;

impl ArrayConfigInitializer {
    #[cold]
    #[inline(never)]
    pub fn initialize<B, U, T, const N: usize>(
        mode: ArrayConfigIndicesMode<'_>,
        path: &mut T,
        loader: &U,
    ) -> crate::error::Result<[B; N]>
    where
        B: ConfigInitializer<T, U>,
        T: BindPath,
        U: PropertyLoader,
    {
        assert!(
            N <= MAX_ARRAY_SIZE,
            "Array size exceeds maximum allowed size of {}",
            MAX_ARRAY_SIZE
        );

        let mut items = heapless::Vec::<B, N>::new();
        match mode {
            ArrayConfigIndicesMode::ZeroIndexed => {
                for index in 0..N {
                    let key: heapless::String<{ MAX_ARRAY_KEY_SIZE_STR }> =
                        heapless::String::try_from(index as u32)
                            .expect("Index too large for heapless::String<4>");
                    path.push_array_index(key.as_str());
                    let result = B::initialize(path, loader);
                    path.pop_array_index();
                    items.push(result?).unwrap_or_else(|_| unreachable!());
                }
            }
            ArrayConfigIndicesMode::Custom(indices) => {
                assert_eq!(
                    indices.len(),
                    N,
                    "Array indices length does not match array size"
                );
                for index in indices {
                    path.push_array_index(index);
                    let result = B::initialize(path, loader);
                    path.pop_array_index();
                    items.push(result?).unwrap_or_else(|_| unreachable!());
                }
            }
        }

        Ok(items.into_array().unwrap_or_else(|_| unreachable!()))
    }
}

impl<'a, T> ArrayConfigBinder<'a, T> {
    pub fn new(mode: ArrayConfigIndicesMode<'a>, items: &'a mut [T]) -> Self {
        Self { mode, items }
    }
}

impl<'a, B, U, T> ConfigBinder<T, U> for ArrayConfigBinder<'a, B>
where
    B: ConfigBinder<T, U>,
    T: BindPath,
    U: PropertyLoader,
{
    #[cold]
    #[inline(never)]
    fn bind(&mut self, path: &mut T, loader: &U) -> crate::error::Result<()> {
        use ArrayConfigIndicesMode::*;
        assert!(
            self.items.len() <= MAX_ARRAY_SIZE,
            "Array size exceeds maximum allowed size of {}",
            MAX_ARRAY_SIZE
        );

        let mut result = Err(Error::NotFound);
        match self.mode {
            ZeroIndexed => {
                for (i, item) in self.items.iter_mut().enumerate() {
                    let key: heapless::String<{ MAX_ARRAY_KEY_SIZE_STR }> =
                        heapless::String::try_from(i as u32)
                            .expect("Index too large for heapless::String<4>");
                    path.push_array_index(key.as_str());
                    match item.bind(path, loader) {
                        Ok(_) => {
                            result = result.or(Ok(()));
                        }
                        Err(e) => {
                            if e != Error::NotFound {
                                return Err(e);
                            }
                        }
                    }
                    path.pop_array_index();
                }
            }
            Custom(indices) => {
                for (i, index) in indices.iter().enumerate() {
                    path.push_array_index(index);
                    match self.items[i].bind(path, loader) {
                        Ok(_) => {
                            result = result.or(Ok(()));
                        }
                        Err(e) => {
                            if e != Error::NotFound {
                                return Err(e);
                            }
                        }
                    }
                    path.pop_array_index();
                }
            }
        }

        result
    }
}

pub struct ArrayRefBinder<'a, T> {
    /// The reference key for the array.
    array_ref: &'static str,
    /// Optional prefix to strip from the array index.
    prefix: Option<&'static str>,
    /// The value to bind to the array reference.
    value: &'a mut T,
}

pub struct ArrayRefInitializer;

impl ArrayRefInitializer {
    #[cold]
    #[inline(never)]
    pub fn initialize<B, T, U>(
        array_ref: &'static str,
        prefix: Option<&'static str>,
        path: &mut T,
        loader: &U,
    ) -> crate::error::Result<B>
    where
        B: ConfigInitializer<T, U>,
        T: BindPath,
        U: PropertyLoader,
    {
        let index: crate::str_ty!() = loader.load_str_value(path.current_path())?;
        let key = if let Some(prefix) = prefix {
            index.strip_prefix(prefix)
        } else {
            Some(index.as_str())
        }
        .ok_or(Error::NotFound)?;

        let mut ref_path = T::new();
        ref_path.push(array_ref);
        ref_path.push_array_index(key);
        B::initialize(&mut ref_path, loader)
    }
}

impl<'a, T> ArrayRefBinder<'a, T> {
    pub fn new(array_ref: &'static str, prefix: Option<&'static str>, value: &'a mut T) -> Self {
        Self {
            array_ref,
            prefix,
            value,
        }
    }
}

/// ConfigBinder implementation for binding array references.
/// This binder allows for binding to a specific array reference in the configuration backend,
/// with an optional prefix to strip from the array index.
impl<'a, T, U, B> ConfigBinder<T, U> for ArrayRefBinder<'a, B>
where
    B: ConfigBinder<T, U>,
    T: BindPath,
    U: PropertyLoader,
{
    #[cold]
    #[inline(never)]
    fn bind(&mut self, path: &mut T, loader: &U) -> crate::error::Result<()> {
        let index: crate::str_ty!() = loader.load_str_value(path.current_path())?;
        let key = if let Some(prefix) = self.prefix {
            index.strip_prefix(prefix)
        } else {
            Some(index.as_str())
        };

        if let Some(key) = key {
            let mut ref_path = T::new();
            ref_path.push(self.array_ref);
            ref_path.push_array_index(key);
            self.value.bind(&mut ref_path, loader)?;
        }

        Ok(())
    }
}

/// ConfigBinder implementation for boolean values.
impl<T, U> ConfigBinder<T, U> for bool
where
    T: BindPath,
    U: PropertyLoader,
{
    #[cold]
    #[inline(never)]
    fn bind(&mut self, path: &mut T, loader: &U) -> crate::error::Result<()> {
        *self = Self::initialize(path, loader)?;

        Ok(())
    }
}

impl<T, U> ConfigInitializer<T, U> for bool
where
    T: BindPath,
    U: PropertyLoader,
{
    #[cold]
    #[inline(never)]
    fn initialize(path: &mut T, loader: &U) -> crate::error::Result<Self> {
        loader.load_bool_value(path.current_path())
    }
}

trait Numeric {}
impl Numeric for i32 {}
impl Numeric for u32 {}
impl Numeric for u16 {}
impl Numeric for i16 {}
impl Numeric for i8 {}
impl Numeric for u8 {}

/// ConfigBinder implementation for numeric types that can be converted from i32.
impl<N, T, U> ConfigBinder<T, U> for N
where
    N: Numeric + TryFrom<i32>,
    T: BindPath,
    U: PropertyLoader,
{
    #[cold]
    #[inline(never)]
    fn bind(&mut self, path: &mut T, loader: &U) -> crate::error::Result<()> {
        *self = Self::initialize(path, loader)?;

        Ok(())
    }
}

impl<N, T, U> ConfigInitializer<T, U> for N
where
    N: Numeric + TryFrom<i32>,
    T: BindPath,
    U: PropertyLoader,
{
    #[cold]
    #[inline(never)]
    fn initialize(path: &mut T, loader: &U) -> crate::error::Result<Self> {
        loader
            .load_number_value(path.current_path())?
            .try_into()
            .map_err(|_| Error::Overflow)
    }
}

/// ConfigBinder implementation for `Option<V>` where `V` is another type that implements `ConfigBinder`.
/// This allows for optional configuration values that may or may not be present in the configuration backend.
/// Existing values are used as the binding baseline so their defaults are preserved when properties are absent.
impl<T, U, V> ConfigBinder<T, U> for Option<V>
where
    T: BindPath,
    U: PropertyLoader,
    V: ConfigBinder<T, U> + ConfigInitializer<T, U>,
{
    #[cold]
    #[inline(never)]
    fn bind(&mut self, path: &mut T, loader: &U) -> crate::error::Result<()> {
        if let Some(value) = self.as_mut() {
            return match value.bind(path, loader) {
                Ok(()) | Err(Error::NotFound) => Ok(()),
                Err(Error::Required) => {
                    *self = None;
                    Ok(())
                }
                Err(e) => Err(e),
            };
        }

        match V::initialize(path, loader) {
            Ok(value) => {
                *self = Some(value);
                Ok(())
            }
            Err(Error::NotFound | Error::Required) => Ok(()),
            Err(e) => Err(e),
        }
    }
}

impl<T, U, V> ConfigInitializer<T, U> for Option<V>
where
    T: BindPath,
    U: PropertyLoader,
    V: ConfigBinder<T, U> + ConfigInitializer<T, U>,
{
    #[cold]
    #[inline(never)]
    fn initialize(path: &mut T, loader: &U) -> crate::error::Result<Self> {
        let mut value = None;
        value.bind(path, loader)?;
        Ok(value)
    }
}