subunit 0.3.1

A subunit v2 protocol implementation in 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

//! Serialization of events

use std::io::Write;

use crc32fast::Hasher;

use crate::{types::number::SubunitNumber, GenResult};

/// Trait that describes the serialization requirements for Subunit events.
///
/// Of particular note is the 'look ahead' `wire_size` method, which allows avoiding bulk data copying.
pub trait Serializable {
    /// Returns the size of a given implementor in bytes after serialization.
    ///
    /// This is used to calculate the size of the serialized event before data
    /// copying takes place, in order to write the length-prefix for variable-sized
    /// components.
    fn wire_size(&self) -> GenResult<SubunitNumber>;

    /// Write the instance to the given writer.
    fn serialize<W: Write>(&self, out: &mut W) -> GenResult<()>;
}

impl<T> Serializable for Option<T>
where
    T: Serializable,
{
    fn wire_size(&self) -> GenResult<SubunitNumber> {
        match self {
            Some(inner) => inner.wire_size(),
            None => SubunitNumber::new(0),
        }
    }

    fn serialize<W: Write>(&self, out: &mut W) -> GenResult<()> {
        match self {
            Some(inner) => inner.serialize(out),
            None => Ok(()),
        }
    }
}

impl<T> Serializable for Vec<T>
where
    T: Serializable,
{
    fn wire_size(&self) -> GenResult<SubunitNumber> {
        let mut size = SubunitNumber::new(self.len() as u32)?.wire_size()?;
        for item in self {
            size = (size + item.wire_size()?)?;
        }
        Ok(size)
    }

    fn serialize<W: Write>(&self, out: &mut W) -> GenResult<()> {
        SubunitNumber::try_from(self.len())?.serialize(out)?;
        for item in self {
            item.serialize(out)?;
        }
        Ok(())
    }
}

impl<T, U> Serializable for (T, U)
where
    T: Serializable,
    U: Serializable,
{
    fn wire_size(&self) -> GenResult<SubunitNumber> {
        let (a, b) = self;
        a.wire_size()? + b.wire_size()?
    }

    fn serialize<W: Write>(&self, out: &mut W) -> GenResult<()> {
        let (a, b) = self;
        a.serialize(out)?;
        b.serialize(out)
    }
}

impl Serializable for u8 {
    fn wire_size(&self) -> GenResult<SubunitNumber> {
        SubunitNumber::new(1)
    }

    fn serialize<W: Write>(&self, out: &mut W) -> GenResult<()> {
        out.write_all(&[*self])?;
        Ok(())
    }
}

impl Serializable for u32 {
    fn wire_size(&self) -> GenResult<SubunitNumber> {
        SubunitNumber::new(4)
    }

    fn serialize<W: Write>(&self, out: &mut W) -> GenResult<()> {
        out.write_all(&self.to_be_bytes())?;
        Ok(())
    }
}

impl Serializable for String {
    fn wire_size(&self) -> GenResult<SubunitNumber> {
        self.len() + SubunitNumber::new(self.len() as u32)?.wire_size()?
    }

    fn serialize<W: Write>(&self, out: &mut W) -> GenResult<()> {
        SubunitNumber::try_from(self.len())?.serialize(out)?;
        out.write_all(self.as_bytes())?;
        Ok(())
    }
}

/// A writer that computes a CRC32 checksum of the data written to it.
pub struct Writer<'a, W> {
    buffer: &'a mut W,
    hasher: Hasher,
}

impl<'a, W> Writer<'a, W>
where
    W: Write,
{
    pub(crate) fn new(buffer: &'a mut W) -> Self {
        Writer {
            buffer,
            hasher: Hasher::new(),
        }
    }

    pub(crate) fn finalize(self) -> u32 {
        self.hasher.finalize()
    }
}

impl<W> Write for Writer<'_, W>
where
    W: Write,
{
    fn write(&mut self, buf: &[u8]) -> std::io::Result<usize> {
        self.hasher.update(buf);
        self.buffer.write(buf)
    }

    fn flush(&mut self) -> std::io::Result<()> {
        self.buffer.flush()
    }
}