deser 0.9.0

An experimental serialization and deserialization library for Rust
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

use deser::de::{DeserializeDriver, DeserializeOwned, Sink, SinkHandle};
use deser::ser::{Chunk, Serialize, SerializeDriver};
use deser::{Atom, Deserialize, Error, Event, State, make_slot_wrapper};

/// Removes the length from container starts, the tests are not about it.
fn without_len(event: deser::Event<'static>) -> deser::Event<'static> {
    match event {
        deser::Event::MapStart(shape) => {
            deser::Event::MapStart(deser::ContainerShape::new().with_order(shape.order()))
        }
        deser::Event::SeqStart(shape) => {
            deser::Event::SeqStart(deser::ContainerShape::new().with_order(shape.order()))
        }
        event => event,
    }
}

/// Event data used by the tests.
#[derive(Debug, Default, Clone, PartialEq)]
struct Marker(u32);

/// Captures the marker attached to the event it receives.
#[derive(Debug, PartialEq)]
struct Probe(Option<u32>);

make_slot_wrapper!(ProbeSlot);

impl<'de> Sink<'de> for ProbeSlot<Probe> {
    fn atom(&mut self, _atom: Atom, state: &mut State) -> Result<(), Error> {
        **self = Some(Probe(state.event::<Marker>().map(|marker| marker.0)));
        Ok(())
    }
}

impl<'de> Deserialize<'de> for Probe {
    fn deserialize_into<'out>(
        out: &'out mut Option<Self>,
        _state: &mut State,
    ) -> SinkHandle<'out, 'de> {
        ProbeSlot::make_handle(out)
    }
}

/// Emits events, attaching a marker to the events where one is given.
fn deserialize<T: DeserializeOwned>(events: Vec<(Event<'_>, Option<u32>)>) -> T {
    let mut out = None;
    {
        let mut driver = DeserializeDriver::new(&mut out);
        for (event, marker) in events {
            if let Some(marker) = marker {
                driver.state_mut().event_mut::<Marker>().0 = marker;
            }
            driver.emit(event).unwrap();
            assert!(driver.state().capture_event_data().is_empty());
        }
    }
    out.unwrap()
}

#[test]
fn test_event_data_is_attached_to_one_event() {
    let probes: Vec<Probe> = deserialize(vec![
        (Event::seq_start(), None),
        (1u64.into(), Some(1)),
        (2u64.into(), None),
        (3u64.into(), Some(3)),
        (Event::SeqEnd, None),
    ]);
    assert_eq!(probes, [Probe(Some(1)), Probe(None), Probe(Some(3))]);
}

#[derive(Debug, PartialEq, Deserialize)]
#[deser(tag = "type")]
enum Probed {
    Variant { first: Probe, second: Probe },
}

#[test]
fn test_event_data_is_replayed() {
    // the tag comes last which means that the fields are recorded and
    // replayed once the tag is known.
    let value: Probed = deserialize(vec![
        (Event::map_start(), None),
        ("first".into(), None),
        (1u64.into(), Some(1)),
        ("second".into(), Some(99)),
        (2u64.into(), None),
        ("type".into(), None),
        ("Variant".into(), Some(100)),
        (Event::MapEnd, None),
    ]);
    assert_eq!(
        value,
        Probed::Variant {
            first: Probe(Some(1)),
            second: Probe(None),
        }
    );
}

/// Attaches a marker to its event when serialized.
struct Marked(u32, Option<u32>);

impl Serialize for Marked {
    fn serialize(&self, state: &mut State) -> Result<Chunk<'_>, Error> {
        if let Some(marker) = self.1 {
            state.event_mut::<Marker>().0 = marker;
        }
        Ok(Chunk::Atom(Atom::U64(self.0 as u64)))
    }
}

#[test]
fn test_event_data_when_serializing() {
    let values = vec![Marked(1, Some(10)), Marked(2, None), Marked(3, Some(30))];
    let expected = vec![
        (Event::seq_start(), None),
        (1u64.into(), Some(10)),
        (2u64.into(), None),
        (3u64.into(), Some(30)),
        (Event::SeqEnd, None),
    ];

    let mut events = Vec::new();
    let mut driver = SerializeDriver::new(&values);
    while let Some((event, _, state)) = driver.next().unwrap() {
        events.push((
            without_len(event.to_static()),
            state.event::<Marker>().map(|x| x.0),
        ));
    }
    assert_eq!(events, expected);

    let mut events = Vec::new();
    SerializeDriver::new(&values)
        .drive(|event, state| {
            events.push((
                without_len(event.to_static()),
                state.event::<Marker>().map(|x| x.0),
            ));
            Ok(())
        })
        .unwrap();
    assert_eq!(events, expected);
}