[go: up one dir, main page]

postcard 1.1.3

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
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

#[test]
#[cfg(feature = "use-crc")]
fn test_crc() {
    use crc::{Crc, CRC_32_ISCSI};

    let data: &[u8] = &[0x01, 0x00, 0x20, 0x30];
    let buffer = &mut [0u8; 32];
    let crc = Crc::<u32>::new(&CRC_32_ISCSI);
    let digest = crc.digest();
    let res = postcard::to_slice_crc32(data, buffer, digest).unwrap();
    assert_eq!(res, &[0x04, 0x01, 0x00, 0x20, 0x30, 0x8E, 0xC8, 0x1A, 0x37]);

    let digest = crc.digest();
    let res = postcard::take_from_bytes_crc32::<[u8; 5]>(res, digest).unwrap();

    let expected_bytes = [0x04, 0x01, 0x00, 0x20, 0x30];
    let remaining_bytes = [];
    assert_eq!(res, (expected_bytes, remaining_bytes.as_slice()));
}

#[test]
#[cfg(feature = "use-crc")]
fn test_crc_8() {
    use crc::{Crc, CRC_8_SMBUS};

    let data: &[u8] = &[0x01, 0x00, 0x20, 0x30];
    let buffer = &mut [0u8; 32];
    let crc = Crc::<u8>::new(&CRC_8_SMBUS);
    let digest = crc.digest();
    let res = postcard::ser_flavors::crc::to_slice_u8(data, buffer, digest).unwrap();
    assert_eq!(res, &[0x04, 0x01, 0x00, 0x20, 0x30, 167]);

    let digest = crc.digest();
    let res = postcard::de_flavors::crc::take_from_bytes_u8::<[u8; 5]>(res, digest).unwrap();

    let expected_bytes = [0x04, 0x01, 0x00, 0x20, 0x30];
    let remaining_bytes = [];
    assert_eq!(res, (expected_bytes, remaining_bytes.as_slice()));
}

#[test]
#[cfg(feature = "use-crc")]
fn test_crc_error() {
    use crc::{Crc, CRC_32_ISCSI};

    let data: &[u8] = &[0x01, 0x00, 0x20, 0x30];
    let buffer = &mut [0u8; 32];
    let crc = Crc::<u32>::new(&CRC_32_ISCSI);
    let digest = crc.digest();
    let res = postcard::to_slice_crc32(data, buffer, digest).unwrap();

    // intentionally corrupt the crc
    let last = res.len() - 1;
    res[last] = 0;

    let digest = crc.digest();
    let res = postcard::take_from_bytes_crc32::<[u8; 5]>(res, digest);

    assert_eq!(res, Err(postcard::Error::DeserializeBadCrc));
}

#[test]
#[cfg(feature = "use-crc")]
fn test_crc_in_method() {
    use crc::{Crc, CRC_32_ISCSI};
    use postcard::{to_slice_crc32, Result};
    use serde::Serialize;

    #[derive(Debug, Serialize)]
    pub struct Thing {
        value: u32,
    }

    impl Thing {
        pub fn to_bytes<'a>(&self, buf: &'a mut [u8]) -> Result<&'a mut [u8]> {
            let crc = Crc::<u32>::new(&CRC_32_ISCSI);
            to_slice_crc32(self, buf, crc.digest())
        }
    }

    let buffer = &mut [0u8; 5];
    let thing = Thing { value: 42 };
    let slice = thing.to_bytes(buffer).unwrap();
    assert_eq!(slice, &[0x2A, 0xB7, 0xF5, 0x22, 0x19]);
}