aioduct 0.1.10

Async-native HTTP client built directly on hyper 1.x — no hyper-util, no legacy
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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198

use std::time::Duration;

/// Configuration for HTTP/2 connections.
///
/// These settings are applied during the HTTP/2 handshake when the client
/// negotiates an h2 connection (e.g., via ALPN over TLS).
#[derive(Clone, Debug)]
pub struct Http2Config {
    pub(crate) initial_stream_window_size: Option<u32>,
    pub(crate) initial_connection_window_size: Option<u32>,
    pub(crate) max_frame_size: Option<u32>,
    pub(crate) adaptive_window: Option<bool>,
    pub(crate) keep_alive_interval: Option<Duration>,
    pub(crate) keep_alive_timeout: Option<Duration>,
    pub(crate) keep_alive_while_idle: Option<bool>,
    pub(crate) max_header_list_size: Option<u32>,
    pub(crate) max_send_buf_size: Option<usize>,
    pub(crate) max_concurrent_reset_streams: Option<usize>,
}

impl Default for Http2Config {
    fn default() -> Self {
        Self::new()
    }
}

impl Http2Config {
    /// Create a new HTTP/2 config with all fields set to `None` (use hyper defaults).
    pub fn new() -> Self {
        Self {
            initial_stream_window_size: None,
            initial_connection_window_size: None,
            max_frame_size: None,
            adaptive_window: None,
            keep_alive_interval: None,
            keep_alive_timeout: None,
            keep_alive_while_idle: None,
            max_header_list_size: None,
            max_send_buf_size: None,
            max_concurrent_reset_streams: None,
        }
    }

    /// Set the initial stream-level flow control window size (bytes).
    pub fn initial_stream_window_size(mut self, size: u32) -> Self {
        self.initial_stream_window_size = Some(size);
        self
    }

    /// Set the initial connection-level flow control window size (bytes).
    pub fn initial_connection_window_size(mut self, size: u32) -> Self {
        self.initial_connection_window_size = Some(size);
        self
    }

    /// Set the max HTTP/2 frame size (bytes). Must be between 16,384 and 16,777,215.
    pub fn max_frame_size(mut self, size: u32) -> Self {
        self.max_frame_size = Some(size);
        self
    }

    /// Enable adaptive flow-control window sizing.
    pub fn adaptive_window(mut self, enabled: bool) -> Self {
        self.adaptive_window = Some(enabled);
        self
    }

    /// Set the interval for HTTP/2 PING frames to keep the connection alive.
    pub fn keep_alive_interval(mut self, interval: Duration) -> Self {
        self.keep_alive_interval = Some(interval);
        self
    }

    /// Set the timeout for HTTP/2 PING acknowledgements (default: 20s in hyper).
    pub fn keep_alive_timeout(mut self, timeout: Duration) -> Self {
        self.keep_alive_timeout = Some(timeout);
        self
    }

    /// Send keep-alive PINGs even when there are no open streams.
    pub fn keep_alive_while_idle(mut self, enabled: bool) -> Self {
        self.keep_alive_while_idle = Some(enabled);
        self
    }

    /// Set the max size of received header list (bytes).
    pub fn max_header_list_size(mut self, size: u32) -> Self {
        self.max_header_list_size = Some(size);
        self
    }

    /// Set the max write buffer size per stream (bytes).
    pub fn max_send_buf_size(mut self, size: usize) -> Self {
        self.max_send_buf_size = Some(size);
        self
    }

    /// Set the max number of concurrent locally-reset streams.
    pub fn max_concurrent_reset_streams(mut self, max: usize) -> Self {
        self.max_concurrent_reset_streams = Some(max);
        self
    }

    #[cfg(not(target_arch = "wasm32"))]
    pub(crate) fn apply<E: Clone>(&self, builder: &mut hyper::client::conn::http2::Builder<E>) {
        if let Some(v) = self.initial_stream_window_size {
            builder.initial_stream_window_size(v);
        }
        if let Some(v) = self.initial_connection_window_size {
            builder.initial_connection_window_size(v);
        }
        if let Some(v) = self.max_frame_size {
            builder.max_frame_size(v);
        }
        if let Some(v) = self.adaptive_window {
            builder.adaptive_window(v);
        }
        if let Some(v) = self.keep_alive_interval {
            builder.keep_alive_interval(v);
        }
        if let Some(v) = self.keep_alive_timeout {
            builder.keep_alive_timeout(v);
        }
        if let Some(v) = self.keep_alive_while_idle {
            builder.keep_alive_while_idle(v);
        }
        if let Some(v) = self.max_header_list_size {
            builder.max_header_list_size(v);
        }
        if let Some(v) = self.max_send_buf_size {
            builder.max_send_buf_size(v);
        }
        if let Some(v) = self.max_concurrent_reset_streams {
            builder.max_concurrent_reset_streams(v);
        }
    }
}

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

    #[test]
    fn default_all_none() {
        let config = Http2Config::default();
        assert!(config.initial_stream_window_size.is_none());
        assert!(config.initial_connection_window_size.is_none());
        assert!(config.max_frame_size.is_none());
        assert!(config.adaptive_window.is_none());
        assert!(config.keep_alive_interval.is_none());
        assert!(config.keep_alive_timeout.is_none());
        assert!(config.keep_alive_while_idle.is_none());
        assert!(config.max_header_list_size.is_none());
        assert!(config.max_send_buf_size.is_none());
        assert!(config.max_concurrent_reset_streams.is_none());
    }

    #[test]
    fn builder_chain() {
        let config = Http2Config::new()
            .initial_stream_window_size(65535)
            .initial_connection_window_size(1048576)
            .max_frame_size(32768)
            .adaptive_window(true)
            .keep_alive_interval(Duration::from_secs(30))
            .keep_alive_timeout(Duration::from_secs(20))
            .keep_alive_while_idle(true)
            .max_header_list_size(8192)
            .max_send_buf_size(131072)
            .max_concurrent_reset_streams(100);

        assert_eq!(config.initial_stream_window_size, Some(65535));
        assert_eq!(config.initial_connection_window_size, Some(1048576));
        assert_eq!(config.max_frame_size, Some(32768));
        assert_eq!(config.adaptive_window, Some(true));
        assert_eq!(config.keep_alive_interval, Some(Duration::from_secs(30)));
        assert_eq!(config.keep_alive_timeout, Some(Duration::from_secs(20)));
        assert_eq!(config.keep_alive_while_idle, Some(true));
        assert_eq!(config.max_header_list_size, Some(8192));
        assert_eq!(config.max_send_buf_size, Some(131072));
        assert_eq!(config.max_concurrent_reset_streams, Some(100));
    }

    #[test]
    fn debug_format() {
        let config = Http2Config::new().max_frame_size(16384);
        let dbg = format!("{config:?}");
        assert!(dbg.contains("Http2Config"));
        assert!(dbg.contains("16384"));
    }

    #[test]
    fn clone() {
        let config = Http2Config::new().adaptive_window(false);
        let cloned = config.clone();
        assert_eq!(cloned.adaptive_window, Some(false));
    }
}