slip-codec 0.4.0

Serial Line Internet Protocol (SLIP) encoder/decoder
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

use crate::{SlipError, MAX_PACKET_SIZE};
use bytes::{Buf, BufMut, Bytes, BytesMut};
use tokio_util::codec::Decoder;

/// SLIP decoding context
#[derive(Debug)]
pub struct SlipDecoder {
    buf: BytesMut,
    capacity: usize,
    inner: crate::SlipDecoder,
}

impl SlipDecoder {
    /// Creates a new context with the given maximum buffer size.
    pub fn with_capacity(capacity: usize) -> Self {
        Self {
            buf: BytesMut::with_capacity(capacity),
            capacity,
            inner: Default::default(),
        }
    }
}

impl Decoder for SlipDecoder {
    type Item = Bytes;
    type Error = SlipError;

    fn decode(&mut self, src: &mut BytesMut) -> Result<Option<Self::Item>, Self::Error> {
        let src = &mut src.reader();
        let dst = {
            self.buf.reserve(self.capacity);
            &mut (&mut self.buf).limit(self.capacity).writer()
        };

        match self.inner.decode(src, dst) {
            Ok(len) => Ok(Some(self.buf.split_to(len).freeze())),
            Err(SlipError::EndOfStream) => Ok(None),
            Err(e) => Err(e),
        }
    }
}

impl Default for SlipDecoder {
    fn default() -> Self {
        Self::with_capacity(MAX_PACKET_SIZE)
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn empty_decode() {
        const INPUT: [u8; 2] = [0xc0, 0xc0];

        let mut slip = SlipDecoder::default();
        let mut buf = BytesMut::from(&INPUT[..]);
        let res = slip.decode(&mut buf).unwrap();
        assert!(res.is_none());
        assert!(buf.is_empty());
    }

    #[test]
    fn simple_decode() {
        const INPUT: [u8; 7] = [0xc0, 0x01, 0x02, 0x03, 0x04, 0x05, 0xc0];
        const DATA: [u8; 5] = [0x01, 0x02, 0x03, 0x04, 0x05];

        let mut slip = SlipDecoder::default();
        let mut buf = BytesMut::from(&INPUT[..]);
        let buf = slip.decode(&mut buf).unwrap().unwrap();
        eprintln!("{}:{}: {:?}", file!(), line!(), buf);
        assert_eq!(DATA.len(), buf.len());
        assert_eq!(&DATA[..], &buf);
    }

    /// Ensure that [ESC, ESC_END] -> [END]
    #[test]
    fn decode_esc_then_esc_end_sequence() {
        const INPUT: [u8; 6] = [0xc0, 0x01, 0xdb, 0xdc, 0x03, 0xc0];
        const DATA: [u8; 3] = [0x01, 0xc0, 0x03];

        let mut slip = SlipDecoder::default();
        let mut buf = BytesMut::from(&INPUT[..]);
        let buf = slip.decode(&mut buf).unwrap().unwrap();
        assert_eq!(DATA.len(), buf.len());
        assert_eq!(&DATA[..], &buf);
    }

    /// Ensure that [ESC, ESC_ESC] -> [ESC]
    #[test]
    fn decode_esc_then_esc_esc_sequence() {
        const INPUT: [u8; 6] = [0xc0, 0x01, 0xdb, 0xdd, 0x03, 0xc0];
        const DATA: [u8; 3] = [0x01, 0xdb, 0x03];

        let mut slip = SlipDecoder::default();
        let mut buf = BytesMut::from(&INPUT[..]);
        let buf = slip.decode(&mut buf).unwrap().unwrap();
        assert_eq!(DATA.len(), buf.len());
        assert_eq!(&DATA[..], &buf);
    }

    #[test]
    fn multi_part_decode() {
        const INPUT_1: [u8; 6] = [0xc0, 0x01, 0x02, 0x03, 0x04, 0x05];
        const INPUT_2: [u8; 6] = [0x05, 0x06, 0x07, 0x08, 0x09, 0xc0];
        const DATA: [u8; 10] = [0x01, 0x02, 0x03, 0x04, 0x05, 0x05, 0x06, 0x07, 0x08, 0x09];

        let mut slip = SlipDecoder::default();
        let mut buf = BytesMut::from(&INPUT_1[..]);

        {
            let res = slip.decode(&mut buf).unwrap();
            assert!(res.is_none());
            assert_eq!(0, buf.len());
        }

        buf.extend_from_slice(&INPUT_2[..]);

        {
            let buf = slip.decode(&mut buf).unwrap().unwrap();
            assert_eq!(DATA.len(), buf.len());
            assert_eq!(&DATA[..], &buf);
        }
    }
}