Struct PoolConfig 

pub struct PoolConfig {
    pub max_size: usize,
    pub min_idle: usize,
    pub create_timeout: Option<Duration>,
    pub idle_timeout: Option<Duration>,
    pub max_lifetime: Option<Duration>,
    pub reap_interval: Option<Duration>,
}

Available on crate feature std only.

Tunable limits and lifecycle policy for a Pool.

Construct one through Pool::builder for the fluent path, or assemble it directly — every field is public, so a configuration can equally be deserialized from a settings file. Validation happens when the pool is built, not when the struct is created; see Builder::build.

Examples

use std::time::Duration;
use pool_mod::PoolConfig;

// Start from the defaults and adjust only what matters.
let cfg = PoolConfig {
    max_size: 16,
    min_idle: 2,
    idle_timeout: Some(Duration::from_secs(300)),
    ..PoolConfig::default()
};

assert_eq!(cfg.max_size, 16);
assert_eq!(cfg.create_timeout, Some(Duration::from_secs(30))); // inherited default

Fields

max_size: usize

Hard upper bound on the number of resources the pool owns at once — idle plus checked out. Must be at least 1.

min_idle: usize

Number of resources to create up front when the pool is built, and the floor the pool keeps ready. Must not exceed max_size.

create_timeout: Option<Duration>

How long Pool::get waits for a resource when the pool is saturated. None waits indefinitely.

idle_timeout: Option<Duration>

Discard and replace an idle resource that has gone unused for at least this long, checked the next time it is borrowed. None disables idle expiry.

max_lifetime: Option<Duration>

Discard and replace a resource older than this, regardless of use, checked the next time it is borrowed. None disables lifetime expiry.

reap_interval: Option<Duration>

How often a background thread should prune idle resources that have outlived idle_timeout or max_lifetime, rather than waiting for them to be rejected on their next checkout. None (the default) runs no background thread; expiry is then applied lazily, on borrow.

The reaper only prunes — it never creates resources — and has no effect unless idle_timeout or max_lifetime is also set.

Trait Implementations

impl Clone for PoolConfig

fn clone(&self) -> PoolConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PoolConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for PoolConfig

fn default() -> Self

A pool of up to ten resources, created on demand, that waits up to thirty seconds for a free resource, never expires idle or aged resources, and runs no background reaper.

impl PartialEq for PoolConfig

fn eq(&self, other: &PoolConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for PoolConfig

impl Eq for PoolConfig

impl StructuralPartialEq for PoolConfig