zerompk 0.7.0

A zero-copy, zero-dependency, no_std-compatible, extremely fast MessagePack serializer 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
146
147
148
149
150
151
152
153
154
155
156
157
158
159

use std::borrow::Cow;
use std::io::{BufReader, Cursor};

use zerompk::Value;

fn sample_value() -> Value<'static> {
    Value::Map(vec![
        (
            Value::String("scalars".into()),
            Value::Array(vec![
                Value::Nil,
                Value::Boolean(true),
                Value::Unsigned(u64::MAX),
                Value::Signed(i64::MIN),
                Value::Float32(1.5),
                Value::Float64(-2.5),
            ]),
        ),
        (
            Value::String("data".into()),
            Value::Array(vec![
                Value::String("hello".into()),
                Value::Binary(vec![0, 1, 2, 255].into()),
                Value::Extension(42, vec![1, 2, 3].into()),
            ]),
        ),
    ])
}

#[test]
fn value_from_preserves_messagepack_types_and_borrows() {
    let text = String::from("borrowed");
    let bytes = [1, 2, 3];

    assert_eq!(Value::from(()), Value::Nil);
    assert_eq!(Value::from(true), Value::Boolean(true));
    assert_eq!(Value::from(42_u16), Value::Unsigned(42));
    assert_eq!(Value::from(-42_i16), Value::Signed(-42));
    assert_eq!(Value::from(1.5_f32), Value::Float32(1.5));
    assert_eq!(Value::from(2.5_f64), Value::Float64(2.5));
    assert_eq!(
        Value::from(text.as_str()),
        Value::String(Cow::Borrowed("borrowed"))
    );
    assert_eq!(
        Value::from(bytes.as_slice()),
        Value::Binary(Cow::Borrowed(&bytes))
    );
    assert_eq!(
        Value::from(String::from("owned")),
        Value::String(Cow::Owned(String::from("owned")))
    );
    assert_eq!(
        Value::from(vec![4_u8, 5]),
        Value::Binary(Cow::Owned(vec![4, 5]))
    );
    assert_eq!(
        Value::from(vec![Value::from(1_u8), Value::from(false)]),
        Value::Array(vec![Value::Unsigned(1), Value::Boolean(false)])
    );
    assert_eq!(Value::from(None::<bool>), Value::Nil);
    assert_eq!(Value::from(Some(7_i32)), Value::Signed(7));
}

#[test]
fn value_containers_use_the_declared_lengths() {
    let encoded = [
        0x82, 0xa1, b'a', 0x93, 0x01, 0x02, 0x03, 0xa1, b'b', 0x81, 0xa1, b'c', 0xc3,
    ];
    let decoded: Value = zerompk::from_msgpack(&encoded).unwrap();

    let Value::Map(entries) = decoded else {
        panic!("expected map");
    };
    assert_eq!(entries.len(), 2);
    assert!(matches!(&entries[0].1, Value::Array(values) if values.len() == 3));
    assert!(matches!(&entries[1].1, Value::Map(values) if values.len() == 1));
}

#[test]
fn value_roundtrip_from_slice() {
    let value = sample_value();
    let encoded = zerompk::to_msgpack_vec(&value).unwrap();
    let decoded: Value = zerompk::from_msgpack(&encoded).unwrap();
    assert_eq!(decoded, value);
    let Value::Map(entries) = decoded else {
        unreachable!()
    };
    assert!(matches!(entries[0].0, Value::String(Cow::Borrowed(_))));
}

#[test]
fn value_reads_from_io_reader() {
    let value = sample_value();
    let encoded = zerompk::to_msgpack_vec(&value).unwrap();
    let decoded: Value<'_> = zerompk::read_msgpack(Cursor::new(encoded)).unwrap();
    assert_eq!(decoded, value);
}

#[test]
fn value_reads_from_bufread_reader() {
    let value = sample_value();
    let encoded = zerompk::to_msgpack_vec(&value).unwrap();
    let mut reader = BufReader::with_capacity(1, Cursor::new(encoded));
    let decoded: Value<'_> = zerompk::read_msgpack_bufread(&mut reader).unwrap();
    assert_eq!(decoded, value);
}

#[test]
fn value_reads_all_extension_header_sizes() {
    for len in [1, 2, 3, 4, 8, 16, 255, 256, 65_536] {
        let value = Value::Extension(-42, vec![0x5a; len].into());
        let encoded = zerompk::to_msgpack_vec(&value).unwrap();
        let decoded: Value = zerompk::from_msgpack(&encoded).unwrap();
        assert_eq!(decoded, value);
    }
}

#[test]
fn timestamp_is_preserved_as_extension() {
    let encoded = [
        0xd6, 0xff, 0x65, 0x53, 0xf1, 0x00, // timestamp32
    ];
    let decoded: Value = zerompk::from_msgpack(&encoded).unwrap();
    assert_eq!(
        decoded,
        Value::Extension(-1, vec![0x65, 0x53, 0xf1, 0x00].into())
    );
    assert_eq!(zerompk::to_msgpack_vec(&decoded).unwrap(), encoded);
}

#[test]
fn value_respects_depth_limit() {
    let mut encoded = vec![0x91; 501];
    encoded.push(0xc0);
    assert!(matches!(
        zerompk::from_msgpack::<Value>(&encoded),
        Err(zerompk::Error::DepthLimitExceeded { .. })
    ));
}

#[test]
fn value_rejects_truncated_extension() {
    let encoded = [0xc7, 3, 42, 1, 2];
    assert!(zerompk::from_msgpack::<Value>(&encoded).is_err());
}

#[test]
fn value_rejects_truncated_huge_containers_without_large_preallocation() {
    for encoded in [
        [0xdd, 0xff, 0xff, 0xff, 0xff],
        [0xdf, 0xff, 0xff, 0xff, 0xff],
    ] {
        assert!(matches!(
            zerompk::from_msgpack::<Value>(&encoded),
            Err(zerompk::Error::BufferTooSmall)
        ));
    }
}