fetch_options 0.2.2

Options types for 'fetch' crate.
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

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.

#![cfg_attr(docsrs, feature(doc_cfg))]
#![doc(html_logo_url = "https://media.githubusercontent.com/media/microsoft/oxidizer/refs/heads/main/crates/fetch_options/logo.png")]
#![doc(html_favicon_url = "https://media.githubusercontent.com/media/microsoft/oxidizer/refs/heads/main/crates/fetch_options/favicon.ico")]

//! Configuration options for HTTP client transport behavior.
//!
//! This crate provides types for configuring various aspects of HTTP connections,
//! including connection keep-alive behavior, connection pooling, and HTTP version support.
//!
//! # Example
//!
//! ```
//! use std::time::Duration;
//!
//! use fetch_options::{ConnectionLifetime, RequestFilter, TransportOptions};
//!
//! fn configure(mut options: TransportOptions) -> TransportOptions {
//!     options.connect_timeout = Duration::from_secs(10);
//!     options.request_filter = RequestFilter::Https;
//!     options.connection_pool = options
//!         .connection_pool
//!         .max_connections(64)
//!         .connection_idle_timeout(Duration::from_secs(90))
//!         .connection_lifetime(ConnectionLifetime::fixed(Duration::from_secs(300)));
//!
//!     options
//! }
//!
//! let options = configure(TransportOptions::default());
//! ```

use std::time::Duration;

mod connection_info;
mod connection_keep_alive;
mod http2;
mod pooling;
mod request_filter;
mod transport;

pub use connection_info::ConnectionInfo;
pub use connection_keep_alive::ConnectionKeepAlive;
pub use http2::Http2Options;
pub use pooling::{ConnectionIdleTimeout, ConnectionLifetime, ConnectionPoolOptions, PoolIndex, PoolSelection};
pub use request_filter::RequestFilter;
pub use transport::TransportOptions;

const DEFAULT_CONNECT_TIMEOUT: Duration = Duration::from_secs(30);

// Matches `SocketsHttpHandler.KeepAlivePingTimeout` in .NET (20 seconds).
const DEFAULT_KEEP_ALIVE_TIMEOUT: Duration = Duration::from_secs(20);

// .NET has no opt-in default for the keep-alive ping interval (`KeepAlivePingDelay`
// defaults to `Timeout.InfiniteTimeSpan`, i.e. disabled). 20 seconds is used here
// only when the caller explicitly enables keep-alive without specifying an interval.
const DEFAULT_KEEP_ALIVE_INTERVAL: Duration = Duration::from_secs(20);

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

    #[cfg_attr(miri, ignore)]
    #[test]
    fn constants_have_expected_values() {
        assert_eq!(DEFAULT_CONNECT_TIMEOUT, Duration::from_secs(30));
        assert_eq!(DEFAULT_KEEP_ALIVE_TIMEOUT, Duration::from_secs(20));
        assert_eq!(DEFAULT_KEEP_ALIVE_INTERVAL, Duration::from_secs(20));
    }
}