plugx-input 1.1.0

simple and flexible data-structure for configuration and state manipulation of plugins.
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

use crate::{Input, error::InputDeserializeError, position::InputPath};
use rkyv::{from_bytes, rancor, to_bytes, util::AlignedVec};

impl Input {
    /// Serializes `self` to rkyv bytes. This cannot fail.
    pub fn to_rkyv_bytes(&self) -> AlignedVec {
        to_bytes::<rancor::Error>(self).expect("Input rkyv serialization cannot fail")
    }

    /// Deserializes `self` from rkyv bytes with structured errors.
    pub fn from_rkyv_bytes(bytes: &[u8]) -> Result<Self, InputDeserializeError> {
        from_bytes::<Input, rancor::Error>(bytes).map_err(|error| {
            InputDeserializeError::InvalidArchive {
                path: InputPath::root(),
                message: error.to_string(),
            }
        })
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::error::InputSerializeError;
    use std::collections::HashMap;

    #[test]
    fn serialize_is_infallible() {
        let input = Input::from("hello");
        let _: Result<AlignedVec, InputSerializeError> = Ok(input.to_rkyv_bytes());
    }

    #[test]
    fn roundtrip() {
        let input = Input::from(HashMap::from([
            ("name".to_string(), Input::from("plugx")),
            ("enabled".to_string(), Input::from(true)),
            ("count".to_string(), Input::from(3)),
            ("ratio".to_string(), Input::from(0.5)),
        ]));
        let bytes = input.to_rkyv_bytes();
        let decoded = Input::from_rkyv_bytes(&bytes).unwrap();
        assert_eq!(input, decoded);
    }

    #[test]
    fn deep_roundtrip() {
        let input = Input::from(HashMap::from([(
            "app".to_string(),
            Input::from(HashMap::from([(
                "logging".to_string(),
                Input::from(HashMap::from([(
                    "filters".to_string(),
                    Input::from(HashMap::from([(
                        "modules".to_string(),
                        Input::from(HashMap::from([(
                            "plugx".to_string(),
                            Input::from(HashMap::from([(
                                "input".to_string(),
                                Input::from(HashMap::from([(
                                    "rkyv".to_string(),
                                    Input::from(true),
                                )])),
                            )])),
                        )])),
                    )])),
                )])),
            )])),
        )]));

        let bytes = input.to_rkyv_bytes();
        let decoded = Input::from_rkyv_bytes(&bytes).unwrap();
        assert_eq!(input, decoded);
    }

    #[test]
    fn rejects_invalid_bytes() {
        let error = Input::from_rkyv_bytes(&[0u8, 1, 2, 3]).unwrap_err();
        assert!(matches!(
            error,
            InputDeserializeError::InvalidArchive { .. }
        ));
    }
}