nyquest-interface 0.5.0

Interface definitions for Nyquest backends
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

//! Configuration options for HTTP clients.

use std::{borrow::Cow, time::Duration};

/// Defines how the HTTP client should handle response caching.
#[derive(Debug, Clone, Copy, Default, PartialEq, Eq)]
pub enum CachingBehavior {
    /// Caching is completely disabled.
    Disabled,
    /// Best effort caching behavior based on the backend capabilities.
    #[default]
    BestEffort,
}

/// Configuration options for proxy settings.
#[derive(Debug, Clone, Default, PartialEq, Eq)]
pub enum ProxyOptions {
    /// Use the system's default proxy settings.
    #[default]
    Default,
    /// Disable system's default proxy settings and do not use any proxy.
    None,
    /// Use custom proxy settings.
    Custom {
        /// The proxy URL to use for HTTP requests.
        http: Option<Cow<'static, str>>,
        /// The proxy URL to use for HTTPS requests.
        https: Option<Cow<'static, str>>,
        /// Optional list of host patterns that should bypass the proxy.
        proxy_bypass: Option<Cow<'static, str>>,
    },
}

/// Configuration options for creating a nyquest HTTP client.
#[derive(Debug, Clone)]
pub struct ClientOptions {
    /// Optional base URL prepended to all request URLs.
    pub base_url: Option<String>,
    /// Optional User-Agent header value to use for all requests.
    pub user_agent: Option<String>,
    /// Headers to include in all requests by default.
    pub default_headers: Vec<(String, String)>,
    /// Controls the caching behavior for HTTP responses.
    pub caching_behavior: CachingBehavior,
    /// Configuration options for proxy settings.
    pub proxy_options: ProxyOptions,
    /// Whether to enable cookie handling.
    pub use_cookies: bool,
    /// Whether to automatically follow redirect responses.
    pub follow_redirects: bool,
    /// Optional maximum buffer size for response bodies.
    pub max_response_buffer_size: Option<u64>,
    /// Optional timeout duration for requests.
    pub request_timeout: Option<Duration>,
    /// Whether to ignore SSL certificate errors.
    pub ignore_certificate_errors: bool,
    // TODO: auth
    // TODO: redirects
}

impl Default for ClientOptions {
    #[inline]
    fn default() -> Self {
        Self {
            base_url: None,
            user_agent: None,
            default_headers: vec![],
            caching_behavior: CachingBehavior::default(),
            proxy_options: ProxyOptions::default(),
            use_cookies: true,
            follow_redirects: true,
            max_response_buffer_size: None,
            request_timeout: None,
            ignore_certificate_errors: false,
        }
    }
}