qbase 0.4.0

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

use std::{fmt, ops};

use crate::param::ParameterId;

/// Roles in the QUIC protocol, including client and server.
///
/// The least significant bit (0x01) of the [`StreamId`](crate::sid) identifies the initiator role of the stream.
/// Client-initiated streams have even-numbered stream IDs (with the bit set to 0),
/// and server-initiated streams have odd-numbered stream IDs (with the bit set to 1).
/// See [section-2.1-3](https://www.rfc-editor.org/rfc/rfc9000.html#section-2.1-3)
/// of [QUIC](https://www.rfc-editor.org/rfc/rfc9000.html).
///
/// # Note
///
/// As a protocol capable of multiplexing streams, QUIC is different from traditional
/// HTTP protocols for clients and servers.
/// In the QUIC protocol, it is not only the client that can actively open a new stream;
/// the server can also actively open a new stream to push some data to the client.
/// In fact, in a new stream, the server can initiate an HTTP3 request to the client,
/// and the client, upon receiving the request, responds back to the server.
/// In this case, the client surprisingly plays the role of the traditional "server",
/// which is quite fascinating.
///
/// # Example
///
/// ```
/// use qbase::role::Role;
///
/// let local = Role::Client;
/// let peer = !local;
/// let is_client = matches!(local, Role::Client); // true
/// let is_server = matches!(peer, Role::Server); // true
/// ```
#[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash)]
pub enum Role {
    /// The initiator of a connection
    Client = 0,
    /// The acceptor of a connection
    Server = 1,
}

impl fmt::Display for Role {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.pad(match *self {
            Self::Client => "client",
            Self::Server => "server",
        })
    }
}

impl ops::Not for Role {
    type Output = Self;
    fn not(self) -> Self {
        match self {
            Self::Client => Self::Server,
            Self::Server => Self::Client,
        }
    }
}

pub trait IntoRole {
    /// Convert the type into a [`Role`].
    fn into_role() -> Role;
}

pub trait RequiredParameters {
    fn required_parameters() -> impl IntoIterator<Item = ParameterId>;
}

#[derive(Default, Debug, Clone, Copy, PartialEq, Eq)]
pub struct Client;

impl From<Client> for Role {
    fn from(_: Client) -> Self {
        Role::Client
    }
}

impl IntoRole for Client {
    fn into_role() -> Role {
        Role::Client
    }
}

impl RequiredParameters for Client {
    fn required_parameters() -> impl IntoIterator<Item = ParameterId> {
        [ParameterId::InitialSourceConnectionId].into_iter()
    }
}

#[derive(Default, Debug, Clone, Copy, PartialEq, Eq)]
pub struct Server;

impl From<Server> for Role {
    fn from(_: Server) -> Self {
        Role::Server
    }
}

impl IntoRole for Server {
    fn into_role() -> Role {
        Role::Server
    }
}

impl RequiredParameters for Server {
    fn required_parameters() -> impl IntoIterator<Item = ParameterId> {
        [
            ParameterId::InitialSourceConnectionId,
            ParameterId::OriginalDestinationConnectionId,
        ]
        .into_iter()
    }
}