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

use super::{
    EncodeSize, GetFrameType,
    io::{WriteFrame, WriteFrameType},
};
use crate::{
    frame::PunchHelloFrame,
    varint::{VarInt, WriteVarInt, be_varint},
};

/// PUNCH_Done Frame {
///     Type (i) = 0x3d7e96,
///     Local Sequence Number (i),
///     Remote Sequence Number (i),
///     Probe Identifier (i),
/// }
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct PunchDoneFrame {
    local_seq: VarInt,
    remote_seq: VarInt,
    probe_id: VarInt,
}

impl PunchDoneFrame {
    pub fn new(local_seq: u32, remote_seq: u32, probe_id: u32) -> Self {
        Self {
            local_seq: VarInt::from_u32(local_seq),
            remote_seq: VarInt::from_u32(remote_seq),
            probe_id: VarInt::from_u32(probe_id),
        }
    }

    pub fn local_seq(&self) -> u32 {
        self.local_seq.into_inner() as u32
    }

    pub fn remote_seq(&self) -> u32 {
        self.remote_seq.into_inner() as u32
    }

    pub fn probe_id(&self) -> u32 {
        self.probe_id.into_inner() as u32
    }

    /// Construct a PunchDone responding to a received PunchHello,
    /// automatically swapping local/remote seq to reflect our perspective.
    pub fn respond_to(hello: &PunchHelloFrame) -> Self {
        Self::new(hello.remote_seq(), hello.local_seq(), hello.probe_id())
    }
}

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

impl EncodeSize for PunchDoneFrame {
    fn max_encoding_size(&self) -> usize {
        4 + 8 + 8 + 8
    }

    fn encoding_size(&self) -> usize {
        VarInt::from(self.frame_type()).encoding_size()
            + self.local_seq.encoding_size()
            + self.remote_seq.encoding_size()
            + self.probe_id.encoding_size()
    }
}

impl<T: bytes::BufMut> WriteFrame<PunchDoneFrame> for T {
    fn put_frame(&mut self, frame: &PunchDoneFrame) {
        self.put_frame_type(frame.frame_type());
        self.put_varint(&frame.local_seq);
        self.put_varint(&frame.remote_seq);
        self.put_varint(&frame.probe_id);
    }
}

pub(crate) fn be_punch_done_frame(input: &[u8]) -> nom::IResult<&[u8], PunchDoneFrame> {
    let (input, local_seq) = be_varint(input)?;
    let (input, remote_seq) = be_varint(input)?;
    let (input, probe_id) = be_varint(input)?;
    Ok((
        input,
        PunchDoneFrame {
            local_seq,
            remote_seq,
            probe_id,
        },
    ))
}