rotbl 0.2.10

Read Only Table
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

use std::fmt;
use std::io::Error;
use std::io::Read;
use std::io::Write;

use codeq::config::CodeqConfig;

use crate::buf;
use crate::typ::Type;
use crate::v001::header::Header;
use crate::v001::rotbl_meta_payload::RotblMetaPayload;
use crate::v001::types::Checksum;
use crate::v001::types::WithChecksum;
use crate::version::Version;

#[derive(Debug)]
#[derive(Clone)]
#[derive(PartialEq, Eq)]
pub struct RotblMeta {
    header: Header,

    payload: RotblMetaPayload,
}

impl RotblMeta {
    pub fn new(seq: u64, user_data: impl ToString) -> Self {
        let header = Header::new(Type::RotblMeta, Version::V001);
        let meta = RotblMetaPayload::new(seq, user_data);
        Self {
            header,
            payload: meta,
        }
    }

    pub fn seq(&self) -> u64 {
        self.payload.seq
    }

    pub fn user_data(&self) -> &str {
        &self.payload.user_data
    }
}

impl fmt::Display for RotblMeta {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{{header: {}, payload: {}}}", self.header, self.payload)
    }
}

impl codeq::Encode for RotblMeta {
    fn encode<W: Write>(&self, mut w: W) -> Result<usize, Error> {
        let mut n = 0usize;

        let mut cw = Checksum::new_writer(&mut w);

        n += self.header.encode(&mut cw)?;

        let encoded_data = serde_json::to_vec(&self.payload)?;
        let encoded_size = encoded_data.len() as u64;

        let s = Checksum::wrap(encoded_size);
        n += s.encode(&mut cw)?;

        cw.write_all(&encoded_data)?;
        n += encoded_size as usize;

        n += cw.write_checksum()?;

        Ok(n)
    }
}

impl codeq::Decode for RotblMeta {
    fn decode<R: Read>(r: R) -> Result<Self, Error> {
        let mut cr = Checksum::new_reader(r);

        let header = Header::decode(&mut cr)?;
        assert_eq!(header, Header::new(Type::RotblMeta, Version::V001));

        let payload_size = WithChecksum::<u64>::decode(&mut cr)?.into_inner();

        let mut buf = buf::new_uninitialized(payload_size as usize);
        cr.read_exact(&mut buf)?;

        cr.verify_checksum(|| "RotblMeta::decode()")?;

        let data = serde_json::from_slice(&buf)?;

        let block = Self {
            header,
            payload: data,
        };

        Ok(block)
    }
}

#[cfg(test)]
#[allow(clippy::redundant_clone)]
mod tests {

    use codeq::testing::test_codec;
    #[allow(unused_imports)]
    use pretty_assertions::assert_eq;

    use crate::v001::rotbl_meta::RotblMeta;
    use crate::v001::testing::bbs;
    use crate::v001::testing::vec_chain;

    #[test]
    fn test_rotbl_meta_codec() -> anyhow::Result<()> {
        let user_data = "hello";
        let rotbl_meta = RotblMeta::new(5, user_data);

        let encoded = vec_chain([
            bbs(["rotbl_m\0"]), // header.type
            vec![
                0, 0, 0, 0, 0, 0, 0, 1, // header.version
                0, 0, 0, 0, 170, 167, 191, 39, // header checksum
                0, 0, 0, 0, 0, 0, 0, 29, // data_encoded_size
                0, 0, 0, 0, 6, 36, 179, 176, // data_encoded_size checksum
            ],
            bbs([r#"{"seq":5,"user_data":"hello"}"#]), // data
            vec![
                0, 0, 0, 0, 230, 11, 170, 59, // checksum
            ],
        ]);

        test_codec(&encoded, &rotbl_meta)?;

        Ok(())
    }
}