zvariant 5.10.1

D-Bus & GVariant encoding & decoding
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

use serde::{Deserialize, Serialize};
use serde_repr::{Deserialize_repr, Serialize_repr};
use zvariant::{Error, LE, OwnedValue, Type, Value, serialized::Context, to_bytes};

#[macro_use]
mod common {
    include!("common.rs");
}

#[test]
fn derive() {
    #[derive(Deserialize, Serialize, Type, PartialEq, Debug)]
    struct Struct<'s> {
        field1: u16,
        field2: i64,
        field3: &'s str,
    }

    assert_eq!(Struct::SIGNATURE, "(qxs)");
    let s = Struct {
        field1: 0xFF_FF,
        field2: 0xFF_FF_FF_FF_FF_FF,
        field3: "hello",
    };
    let ctxt = Context::new_dbus(LE, 0);
    let encoded = to_bytes(ctxt, &s).unwrap();
    assert_eq!(encoded.len(), 26);
    let decoded: Struct<'_> = encoded.deserialize().unwrap().0;
    assert_eq!(decoded, s);

    #[derive(Deserialize, Serialize, Type)]
    struct UnitStruct;

    assert_eq!(UnitStruct::SIGNATURE, <()>::SIGNATURE);
    let encoded = to_bytes(ctxt, &UnitStruct).unwrap();
    assert_eq!(encoded.len(), 0);
    let _: UnitStruct = encoded.deserialize().unwrap().0;

    #[repr(u8)]
    #[derive(Deserialize_repr, Serialize_repr, Type, Value, OwnedValue, Debug, PartialEq)]
    enum Enum {
        Variant1,
        Variant2,
        Variant3,
    }

    assert_eq!(Enum::SIGNATURE, u8::SIGNATURE);
    let encoded = to_bytes(ctxt, &Enum::Variant3).unwrap();
    assert_eq!(encoded.len(), 1);
    let decoded: Enum = encoded.deserialize().unwrap().0;
    assert_eq!(decoded, Enum::Variant3);

    assert_eq!(Value::from(Enum::Variant1), Value::U8(0));
    assert_eq!(Enum::try_from(Value::U8(2)), Ok(Enum::Variant3));
    assert_eq!(Enum::try_from(Value::U8(4)), Err(Error::IncorrectType));

    #[repr(i64)]
    #[derive(Deserialize_repr, Serialize_repr, Type, Value, OwnedValue, Debug, PartialEq)]
    enum Enum2 {
        Variant1,
        Variant2,
        Variant3,
    }

    assert_eq!(Enum2::SIGNATURE, i64::SIGNATURE);
    let encoded = to_bytes(ctxt, &Enum2::Variant2).unwrap();
    assert_eq!(encoded.len(), 8);
    let decoded: Enum2 = encoded.deserialize().unwrap().0;
    assert_eq!(decoded, Enum2::Variant2);

    assert_eq!(Value::from(Enum2::Variant1), Value::I64(0));
    assert_eq!(Enum2::try_from(Value::I64(2)), Ok(Enum2::Variant3));
    assert_eq!(Enum2::try_from(Value::I64(4)), Err(Error::IncorrectType));

    #[derive(Deserialize, Serialize, Type, Value, OwnedValue, Debug, PartialEq)]
    enum NoReprEnum {
        Variant1,
        Variant2,
        Variant3,
    }

    // issue#265: Panic on deserialization of a structure w/ a unit enum as its last field.
    let encoded = to_bytes(ctxt, &(NoReprEnum::Variant2,)).unwrap();
    let _: (NoReprEnum,) = encoded.deserialize().unwrap().0;

    assert_eq!(NoReprEnum::SIGNATURE, u32::SIGNATURE);
    let encoded = to_bytes(ctxt, &NoReprEnum::Variant2).unwrap();
    assert_eq!(encoded.len(), 4);
    let decoded: NoReprEnum = encoded.deserialize().unwrap().0;
    assert_eq!(decoded, NoReprEnum::Variant2);

    #[derive(Deserialize, Serialize, Type, Value, OwnedValue, Debug, PartialEq)]
    #[zvariant(signature = "s", rename_all = "snake_case")]
    enum StrEnum {
        VariantOne,
        Variant2,
        Variant3,
    }

    assert_eq!(StrEnum::SIGNATURE, <&str>::SIGNATURE);
    let encoded = to_bytes(ctxt, &StrEnum::Variant2).unwrap();
    assert_eq!(encoded.len(), 13);
    let decoded: StrEnum = encoded.deserialize().unwrap().0;
    assert_eq!(decoded, StrEnum::Variant2);

    assert_eq!(
        StrEnum::try_from(Value::Str("variant_one".into())),
        Ok(StrEnum::VariantOne)
    );
    assert_eq!(
        StrEnum::try_from(Value::Str("variant2".into())),
        Ok(StrEnum::Variant2)
    );
    assert_eq!(
        StrEnum::try_from(Value::Str("variant4".into())),
        Err(Error::IncorrectType)
    );
    assert_eq!(StrEnum::try_from(Value::U32(0)), Err(Error::IncorrectType));

    #[derive(Deserialize, Serialize, Type)]
    enum NewType {
        Variant1(f64),
        Variant2(f64),
    }
    assert_eq!(NewType::SIGNATURE, "(ud)");

    #[derive(Deserialize, Serialize, Type)]
    enum StructFields {
        Variant1(u16, i64, &'static str),
        Variant2 {
            field1: u16,
            field2: i64,
            field3: &'static str,
        },
    }
    assert_eq!(StructFields::SIGNATURE, "(u(qxs))");

    #[derive(Deserialize, Serialize, Type, PartialEq, Debug)]
    struct AStruct<'s> {
        field1: u16,
        field2: &'s [u8],
        field3: &'s [u8],
        field4: i64,
    }
    assert_eq!(AStruct::SIGNATURE, "(qayayx)");
    let s = AStruct {
        field1: 0xFF_FF,
        field2: &[77u8; 8],
        field3: &[77u8; 8],
        field4: 0xFF_FF_FF_FF_FF_FF,
    };
    let encoded = to_bytes(ctxt, &s).unwrap();
    assert_eq!(encoded.len(), 40);
    let decoded: AStruct<'_> = encoded.deserialize().unwrap().0;
    assert_eq!(decoded, s);
}