shvproto 6.1.5

Rust implementation of the SHV protocol
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

mod ser;
mod de;

use std::collections::BTreeMap;
use std::ops::Deref;
use std::ops::DerefMut;

pub use ser::ValueSerializer;
pub use ser::to_rpcvalue;
pub use de::ValueDeserializer;
pub use de::from_rpcvalue;

use crate::Value;

#[derive(Clone,Debug,serde::Serialize,PartialEq)]
pub struct IMap<T: Into<Value>>(BTreeMap<i32, T>);

impl<T: Into<Value>> Deref for IMap<T> {
    type Target = BTreeMap<i32, T>;

    fn deref(&self) -> &Self::Target {
        &self.0
    }
}

impl<T: Into<Value>> DerefMut for IMap<T> {
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut self.0
    }
}

impl<T: Into<Value>> From<BTreeMap<i32, T>> for IMap<T> {
    fn from(value: BTreeMap<i32, T>) -> Self {
        Self(value)
    }
}

impl<T: Into<Value>> From<IMap<T>> for BTreeMap<i32, T> {
    fn from(value: IMap<T>) -> Self {
        value.0
    }
}

#[derive(Clone,Debug,PartialEq)]
pub struct Blob(Vec<u8>);

impl Deref for Blob {
    type Target = Vec<u8>;

    fn deref(&self) -> &Self::Target {
        &self.0
    }
}

impl DerefMut for Blob {
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut self.0
    }
}

impl From<Vec<u8>> for Blob {
    fn from(value: Vec<u8>) -> Self {
        Self(value)
    }
}

impl<const N: usize> From<[u8; N]> for Blob {
    fn from(value: [u8; N]) -> Self {
        Self(value.into())
    }
}

impl From<&[u8]> for Blob {
    fn from(value: &[u8]) -> Self {
        Self(value.into())
    }
}

impl From<Blob> for Vec<u8> {
    fn from(value: Blob) -> Self {
        value.0
    }
}

#[cfg(test)]
mod tests {
    use std::collections::BTreeMap;

    use super::{Blob, IMap};


    #[derive(Debug, serde::Serialize, serde::Deserialize, PartialEq)]
    #[serde(untagged)]
    enum UntaggedEnum {
        Color { r: u8, g: u8, b: u8 },
    }

    #[derive(Debug, serde::Serialize, serde::Deserialize, PartialEq)]
    #[serde(tag = "t")]
    enum InternallyTaggedEnum {
        Color { r: u8, g: u8, b: u8 },
    }

    #[derive(Debug, serde::Serialize, serde::Deserialize, PartialEq)]
    #[serde(tag = "t", content = "c")]
    enum InternallyTaggedExtraContentEnum {
        Color { r: u8, g: u8, b: u8 },
    }

    #[derive(Debug, serde::Serialize, serde::Deserialize, PartialEq)]
    enum ExternallyTaggedEnum {
        Color { r: u8, g: u8, b: u8 },
        Point2D(f64, f64),
        Unit,
    }

    #[derive(Debug, serde::Serialize, serde::Deserialize, PartialEq)]
    struct UserStruct {
        string: String,
        num: i8,
        flag: bool,
        map: BTreeMap<String, i32>,
        imap: IMap<String>,
        date_time: crate::DateTime,
        list: Vec<i32>,
        blob: Blob,
        untagged: UntaggedEnum,
        internally_tagged: InternallyTaggedEnum,
        internally_tagged_extra_content: InternallyTaggedExtraContentEnum,
        externally_tagged: ExternallyTaggedEnum,
        externally_tagged_tuple: ExternallyTaggedEnum,
        externally_tagged_unit: ExternallyTaggedEnum,
    }

    #[test]
    fn serialize_and_deserialize() {
        let date_time = crate::DateTime::from_iso_str("2025-07-31T18:51:00.220+02").unwrap();
        let blob = [1_u8, 2_u8, 3_u8];
        let user_from = UserStruct {
            string: "test".into(),
            num: 42,
            flag: true,
            map: BTreeMap::from([("abc".into(), 123)]),
            imap: IMap(BTreeMap::from([(1, "xyz".into())])),
            date_time,
            list: [10, 20, 30].into(),
            blob: blob.into(),
            untagged: UntaggedEnum::Color { r: 100, g: 200, b: 250 },
            internally_tagged: InternallyTaggedEnum::Color { r: 100, g: 200, b: 250 },
            internally_tagged_extra_content: InternallyTaggedExtraContentEnum::Color { r: 100, g: 200, b: 250 },
            externally_tagged: ExternallyTaggedEnum::Color { r: 100, g: 200, b: 250 },
            externally_tagged_tuple: ExternallyTaggedEnum::Point2D(0.5, 0.75),
            externally_tagged_unit: ExternallyTaggedEnum::Unit,
        };
        let user_to: UserStruct = super::from_rpcvalue(&super::to_rpcvalue(&user_from).unwrap()).unwrap();
        assert_eq!(user_from, user_to);

    }
}