Skip to main content

PoolConfig

Struct PoolConfig 

Source
pub struct PoolConfig {
    pub max_in_flight: Option<usize>,
    pub governor_acquire_timeout: Duration,
    pub max_connections_per_provider: usize,
    pub min_idle_connections: usize,
    pub idle_timeout: Duration,
    pub max_lifetime: Duration,
    pub health_check_interval: Duration,
    pub acquire_timeout: Duration,
    pub enable_health_check: bool,
}
Expand description

Configuration for the client pool

Fields§

§max_in_flight: Option<usize>

Maximum number of in-flight dispatches admitted per provider.

None (default) keeps admission unlimited — governed wrappers are never installed and behavior is unchanged. See ProviderGovernor for the WHO-vs-HOW-MUCH throttle split: this caps how much load one backend absorbs; tenant-level quotas decide who may call at all.

§governor_acquire_timeout: Duration

Maximum time a dispatch waits for an in-flight slot before failing closed (only relevant when max_in_flight is set).

§max_connections_per_provider: usize

Maximum number of clients per provider (default: 10)

§min_idle_connections: usize

Minimum number of idle clients to maintain per provider (default: 2)

§idle_timeout: Duration

Maximum time a client can be idle before being considered stale (default: 5 minutes)

§max_lifetime: Duration

Maximum lifetime of a client before forced refresh (default: 30 minutes)

§health_check_interval: Duration

How often to run health checks on idle connections (default: 60 seconds)

§acquire_timeout: Duration

Timeout for acquiring a client from the pool (default: 30 seconds)

§enable_health_check: bool

Whether to enable connection health checking (default: true)

Implementations§

Source§

impl PoolConfig

Source

pub fn with_max_connections(self, max: usize) -> Self

Create a new pool config with custom max connections

Source

pub fn with_max_in_flight(self, max: usize) -> Self

Enable a per-provider in-flight cap of max concurrent dispatches.

Admission happens at the wrap funnel ([ProviderPool::acquire] and [ProviderPool::try_acquire]) so every checkout path — pooled or freshly created clients alike — is governed identically. The permit spans the whole call, streams included.

Source

pub fn with_governor_acquire_timeout(self, timeout: Duration) -> Self

Set the wait budget for acquiring an in-flight slot.

Source

pub fn governor_config(&self) -> GovernorConfig

Effective governor configuration for this pool.

Source

pub fn with_idle_timeout(self, timeout: Duration) -> Self

Create a new pool config with custom idle timeout

Source

pub fn with_max_lifetime(self, lifetime: Duration) -> Self

Create a new pool config with custom max lifetime

Source

pub fn without_health_check(self) -> Self

Disable health checking (useful for testing)

Trait Implementations§

Source§

impl Clone for PoolConfig

Source§

fn clone(&self) -> PoolConfig

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PoolConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for PoolConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for PoolConfig

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Display for PoolConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for PoolConfig

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for PoolConfig

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for PoolConfig

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more