deadpool 0.13.0

Dead simple async pool
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

use std::time::Duration;

use crate::Runtime;

/// Pool configuration.
#[derive(Clone, Copy, Debug)]
#[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize))]
pub struct PoolConfig {
    /// Maximum size of the pool.
    pub max_size: usize,

    /// Timeout for [`Pool::get()`] operation.
    ///
    /// [`Pool::get()`]: super::Pool::get
    pub timeout: Option<Duration>,

    /// [`Runtime`] to be used.
    ///
    /// # Important
    ///
    /// The [`Runtime`] is optional. Most [`Pool`]s don't need a [`Runtime`].
    /// If you want to utilize a timeout, however, a [`Runtime`] must be
    /// specified as you will otherwise get a [`PoolError::NoRuntimeSpecified`]
    /// when trying to use [`Pool::timeout_get()`] or [`Pool::get()`] with a
    /// [`PoolConfig::timeout`] configured.
    ///
    /// [`Pool`]: super::Pool
    /// [`Pool::get()`]: super::Pool::get()
    /// [`Pool::timeout_get()`]: super::Pool::timeout_get()
    /// [`PoolError::NoRuntimeSpecified`]: super::PoolError::NoRuntimeSpecified
    #[cfg_attr(feature = "serde", serde(skip))]
    pub runtime: Option<Runtime>,
}

impl PoolConfig {
    /// Create a new [`PoolConfig`] without any timeouts.
    #[must_use]
    pub fn new(max_size: usize) -> Self {
        Self {
            max_size,
            timeout: None,
            runtime: None,
        }
    }
}

impl Default for PoolConfig {
    /// Create a [`PoolConfig`] where [`PoolConfig::max_size`] is set to
    /// `cpu_core_count * 2` including logical cores (Hyper-Threading).
    fn default() -> Self {
        Self::new(crate::util::get_default_pool_max_size())
    }
}