qbase 0.5.0

Core structure of the QUIC protocol, a part of dquic
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

use crate::{
    frame::{GetFrameType, io::WriteFrameType},
    varint::{VarInt, WriteVarInt, be_varint},
};

/// MAX_DATA Frame
///
/// ```text
/// MAX_DATA Frame {
///   Type (i) = 0x10,
///   Maximum Data (i),
/// }
/// ```
///
/// See [MAX_DATA Frames](https://www.rfc-editor.org/rfc/rfc9000.html#name-max_data-frames)
/// of [QUIC](https://www.rfc-editor.org/rfc/rfc9000.html) for more details.
#[derive(Debug, Clone, Copy, Default, PartialEq, Eq)]
pub struct MaxDataFrame {
    max_data: VarInt,
}

impl super::GetFrameType for MaxDataFrame {
    fn frame_type(&self) -> super::FrameType {
        super::FrameType::MaxData
    }
}

impl super::EncodeSize for MaxDataFrame {
    fn max_encoding_size(&self) -> usize {
        1 + 8
    }

    fn encoding_size(&self) -> usize {
        1 + self.max_data.encoding_size()
    }
}

impl MaxDataFrame {
    /// Create a new [`MaxDataFrame`] with the given maximum data.
    pub fn new(max_data: VarInt) -> Self {
        Self { max_data }
    }

    /// Return the maximum data of the frame.
    pub fn max_data(&self) -> u64 {
        self.max_data.into_inner()
    }
}

/// Parse a MAX_DATA frame from the input buffer,
/// [nom](https://docs.rs/nom/latest/nom/) parser style.
pub fn be_max_data_frame(input: &[u8]) -> nom::IResult<&[u8], MaxDataFrame> {
    use nom::{Parser, combinator::map};
    map(be_varint, MaxDataFrame::new).parse(input)
}

impl<T: bytes::BufMut> super::io::WriteFrame<MaxDataFrame> for T {
    fn put_frame(&mut self, frame: &MaxDataFrame) {
        self.put_frame_type(frame.frame_type());
        self.put_varint(&frame.max_data);
    }
}

#[cfg(test)]
mod tests {
    use super::MaxDataFrame;
    use crate::{
        frame::{
            EncodeSize, FrameType, GetFrameType,
            io::{WriteFrame, WriteFrameType},
        },
        varint::VarInt,
    };

    #[test]
    fn test_max_data_frame() {
        let frame = MaxDataFrame::new(VarInt::from_u32(0x1234));
        assert_eq!(frame.frame_type(), FrameType::MaxData);
        assert_eq!(frame.max_encoding_size(), 1 + 8);
        assert_eq!(frame.encoding_size(), 1 + 2);
    }

    #[test]
    fn test_read_max_data_frame() {
        use nom::{Parser, combinator::flat_map};

        use super::be_max_data_frame;
        use crate::varint::be_varint;
        let max_data_frame_type = VarInt::from(FrameType::MaxData);
        let buf = vec![max_data_frame_type.into_inner() as u8, 0x52, 0x34];
        let (input, frame) = flat_map(be_varint, |frame_type| {
            if frame_type == max_data_frame_type {
                be_max_data_frame
            } else {
                panic!("wrong frame type: {frame_type}")
            }
        })
        .parse(buf.as_ref())
        .unwrap();
        assert!(input.is_empty());
        assert_eq!(frame, MaxDataFrame::new(VarInt::from_u32(0x1234),));
    }

    #[test]
    fn test_write_max_data_frame() {
        let mut buf = Vec::new();
        buf.put_frame(&MaxDataFrame::new(VarInt::from_u32(0x1234)));
        let mut expected = Vec::new();
        expected.put_frame_type(FrameType::MaxData);
        expected.extend_from_slice(&[0x52, 0x34]);
        assert_eq!(buf, expected);
    }
}