rama-net 0.4.0

rama network types and utilities
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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168

use crate::{
    AuthorityInputExt, Protocol, ProtocolInputExt, TransportProtocolInputExt,
    address::{HostWithOptPort, HostWithPort},
    transport::TransportProtocol,
};

use rama_core::{Fork, extensions::Extensions, extensions::ExtensionsRef};

#[cfg(feature = "http")]
use crate::{
    HttpVersionInputExt, TargetHttpVersionInputExt,
    http::{HttpRequestVersion, TargetHttpVersion, Version},
};

#[non_exhaustive]
#[derive(Debug, Clone)]
/// A protocol-independent request to establish a client connection.
pub struct ConnectRequest {
    pub authority: HostWithPort,
    pub extensions: Extensions,
    pub application_protocol: Option<Protocol>,
    pub transport_protocol: Option<TransportProtocol>,
}

impl ConnectRequest {
    /// Create a new [`ConnectRequest`] with default [`Extensions`].
    #[must_use]
    pub fn new(authority: HostWithPort) -> Self {
        Self {
            authority,
            extensions: Extensions::new(),
            application_protocol: None,
            transport_protocol: None,
        }
    }

    /// Create a new [`ConnectRequest`] with given [`Extensions`].
    #[must_use]
    pub const fn new_with_extensions(authority: HostWithPort, extensions: Extensions) -> Self {
        Self {
            authority,
            extensions,
            application_protocol: None,
            transport_protocol: None,
        }
    }

    rama_utils::macros::generate_set_and_with! {
        /// Define the application [`Protocol`] to this [`ConnectRequest`]
        /// requested for this connection.
        ///
        /// By default the flow context will define the used application protocol.
        pub fn application_protocol(mut self, protocol: Option<Protocol>) -> Self {
            self.application_protocol = protocol;
            self
        }
    }

    rama_utils::macros::generate_set_and_with! {
        /// Define the [`TransportProtocol`] to this [`ConnectRequest`]
        /// requested for this connection.
        ///
        /// By default it will defined by the flow receiver itself.
        pub fn transport_protocol(mut self, protocol: Option<TransportProtocol>) -> Self {
            self.transport_protocol = protocol;
            self
        }
    }
}

impl Fork for ConnectRequest {
    fn fork(&self) -> Self {
        Self {
            authority: self.authority.clone(),
            extensions: self.extensions.fork(),
            application_protocol: self.application_protocol.clone(),
            transport_protocol: self.transport_protocol,
        }
    }
}

impl ExtensionsRef for ConnectRequest {
    fn extensions(&self) -> &Extensions {
        &self.extensions
    }
}

impl AuthorityInputExt for ConnectRequest {
    fn authority(&self) -> Option<HostWithOptPort> {
        Some(self.authority.clone().into())
    }
}

impl ProtocolInputExt for ConnectRequest {
    fn protocol(&self) -> Option<&Protocol> {
        self.application_protocol.as_ref()
    }
}

impl TransportProtocolInputExt for ConnectRequest {
    fn transport_protocol(&self) -> Option<TransportProtocol> {
        self.transport_protocol
    }
}

#[cfg(feature = "http")]
impl TargetHttpVersionInputExt for ConnectRequest {
    fn target_http_version(&self) -> Option<Version> {
        self.extensions
            .get_ref::<TargetHttpVersion>()
            .map(|target| target.0)
    }
}

#[cfg(feature = "http")]
impl HttpVersionInputExt for ConnectRequest {
    fn http_version(&self) -> Option<Version> {
        self.extensions
            .get_ref::<HttpRequestVersion>()
            .map(|version| version.0)
    }
}

#[cfg(test)]
mod tests {
    use rama_core::extensions::Extension;

    use super::*;

    #[derive(Debug, Extension)]
    struct AttemptMarker;

    #[test]
    fn fork_isolates_attempt_extensions() {
        let request = ConnectRequest::new(HostWithPort::example_domain_https());
        let attempt = request.fork();

        attempt.extensions.insert(AttemptMarker);

        assert!(!request.extensions.contains::<AttemptMarker>());
        assert!(attempt.extensions.contains::<AttemptMarker>());
    }

    #[cfg(feature = "http")]
    #[test]
    fn target_http_version_comes_from_extension() {
        let request = ConnectRequest::new(HostWithPort::example_domain_https());
        assert_eq!(request.target_http_version(), None);

        request
            .extensions
            .insert(TargetHttpVersion(Version::HTTP_2));

        assert_eq!(request.target_http_version(), Some(Version::HTTP_2));
    }

    #[cfg(feature = "http")]
    #[test]
    fn request_http_version_is_not_a_target_requirement() {
        let request = ConnectRequest::new(HostWithPort::example_domain_https());
        request
            .extensions
            .insert(HttpRequestVersion(Version::HTTP_2));

        assert_eq!(request.http_version(), Some(Version::HTTP_2));
        assert_eq!(request.target_http_version(), None);
    }
}