monoio-client 0.1.0

A generic client which supports pooling, timeout and more
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

use std::time::Duration;

/// [`Client`] configuration.
///
/// [`Client`]: super::Client
#[derive(Clone, Copy, Debug)]
#[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize))]
pub struct ClientConfig {
    /// Maximum size of the [`Client`].
    ///
    /// Default: `cpu_count * 4`
    ///
    /// [`Client`]: super::Client
    pub max_size: usize,

    /// Timeouts of the [`Client`].
    ///
    /// Default: No timeouts
    ///
    /// [`Client`]: super::Client
    #[cfg_attr(feature = "serde", serde(default))]
    pub timeouts: Timeouts,
}

impl ClientConfig {
    /// Creates a new [`ClientConfig`] without any timeouts and with the provided
    /// `max_size`.
    #[must_use]
    pub fn new(max_size: usize) -> Self {
        Self {
            max_size,
            timeouts: Timeouts::default(),
        }
    }
}

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

/// Timeouts when getting [`connection`]s from a [`Client`].
///
/// [`connection`]: super::connection
/// [`Client`]: super::Client
#[derive(Clone, Copy, Debug)]
#[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize))]
pub struct Timeouts {
    /// Timeout when waiting for a slot to become available.
    pub wait: Option<Duration>,

    /// Timeout when creating a new connection.
    pub connect: Option<Duration>,

    /// Timeout when recycling an connection.
    pub reuse: Option<Duration>,
}

impl Timeouts {
    /// Create an empty [`Timeouts`] config (no timeouts set).
    #[must_use]
    pub fn new() -> Self {
        Self::default()
    }

    /// Creates a new [`Timeouts`] config with only the `wait` timeout being
    /// set.
    #[must_use]
    pub fn wait_millis(wait: u64) -> Self {
        Self {
            connect: None,
            wait: Some(Duration::from_millis(wait)),
            reuse: None,
        }
    }
}

// Implemented manually to provide a custom documentation.
impl Default for Timeouts {
    /// Creates an empty [`Timeouts`] config (no timeouts set).
    fn default() -> Self {
        Self {
            connect: None,
            wait: None,
            reuse: None,
        }
    }
}