postcard2 0.2.1

A no_std + serde compatible message 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

#![cfg_attr(not(any(test, feature = "std")), no_std)]
#![warn(missing_docs)]
#![cfg_attr(not(doctest), doc = include_str!("../README.md"))]
#![cfg_attr(docsrs, feature(doc_cfg))]

mod de;

pub mod fixint;
mod ser;
// todo: keep public?
pub mod varint;

pub use de::deserializer::{Deserializer, DeserializerError};
pub use de::flavors::{self as de_flavors, UnexpectedEnd};
pub use de::{from_bytes, take_from_bytes};
pub use ser::flavors::{self as ser_flavors, BufferFull};
pub use ser::{
    serialize_with_flavor, serialized_size,
    serializer::{Serializer, SerializerError},
    to_extend, to_slice,
};

#[cfg(feature = "std")]
pub use ser::to_io;

#[cfg(feature = "std")]
pub use de::from_io;

#[cfg(any(feature = "alloc", feature = "std"))]
pub use ser::to_vec;

#[cfg(test)]
mod test {
    #[test]
    fn varint_boundary_canon() {
        let x = u32::MAX;
        let mut buf = [0u8; 5];
        let used = crate::to_slice(&x, &mut buf).unwrap();
        let deser: u32 = crate::from_bytes(used).unwrap();
        assert_eq!(deser, u32::MAX);
        assert_eq!(used, &mut [0xFF, 0xFF, 0xFF, 0xFF, 0x0F]);
        let deser: Result<u32, crate::de::deserializer::DeserializerError<_, _>> =
            crate::from_bytes(&[0xFF, 0xFF, 0xFF, 0xFF, 0x1F]);
        assert_eq!(
            deser,
            Err(crate::de::deserializer::DeserializerError::BadVarint)
        );
    }

    #[test]
    fn signed_int128() {
        let x = -19490127978232325886905073712831_i128;
        let mut buf = [0u8; 32];
        let used = crate::to_slice(&x, &mut buf).unwrap();
        let deser: i128 = crate::from_bytes(used).unwrap();
        assert_eq!(deser, x);
    }
}