Skip to main content

SyncPoolConfig

Struct SyncPoolConfig 

Source
pub struct SyncPoolConfig {
    pub endpoint: String,
    pub database: String,
    pub create_mode: CreateMode,
    pub user: Option<String>,
    pub password: Option<String>,
    pub max_size: usize,
    pub recycle: SyncRecycleStrategy,
    pub wait_timeout: Option<Duration>,
    pub max_lifetime: Option<Duration>,
    pub idle_timeout: Option<Duration>,
    pub min_idle: Option<u32>,
}
Expand description

Configuration and builder for the synchronous ConnectionPool.

Mirrors the async PoolConfig surface. All optional knobs default to None/disabled and recycle defaults to SyncRecycleStrategy::SelectOne, so a config that sets only endpoint/database/max_size opens connections lazily and probes them with SELECT 1 on checkout — the natural baseline.

§Timeout support

The sync pool enforces wait_timeout natively (it bounds how long ConnectionPool::get blocks waiting for a slot). create_timeout and recycle_timeout require an async runtime to interrupt a blocking syscall and are therefore async-only (PoolConfig); they are intentionally absent here to avoid pulling Tokio into the sync path.

Fields§

§endpoint: String

Server endpoint (e.g., “localhost:7483”).

§database: String

Database path.

§create_mode: CreateMode

Database creation mode (only used for the first connection).

§user: Option<String>

Optional username for authentication.

§password: Option<String>

Optional password for authentication.

§max_size: usize

Maximum number of connections in the pool.

§recycle: SyncRecycleStrategy

Per-checkout recycle strategy. Defaults to SyncRecycleStrategy::SelectOne.

§wait_timeout: Option<Duration>

Maximum time ConnectionPool::get blocks waiting for a slot. None waits indefinitely (the default).

§max_lifetime: Option<Duration>

Maximum lifetime of a physical connection before it is retired at checkout.

§idle_timeout: Option<Duration>

Maximum idle time before a connection is retired at checkout (down to min_idle, which is kept warm).

§min_idle: Option<u32>

Minimum number of idle connections to keep warm (biases idle eviction).

Implementations§

Source§

impl SyncPoolConfig

Source

pub fn new(endpoint: impl Into<String>, database: impl Into<String>) -> Self

Creates a new synchronous pool configuration.

Source

pub fn create_mode(self, mode: CreateMode) -> Self

Sets the database creation mode.

Source

pub fn auth(self, user: impl Into<String>, password: impl Into<String>) -> Self

Sets authentication credentials.

Source

pub fn max_size(self, size: usize) -> Self

Sets the maximum pool size.

Source

pub fn recycle(self, strategy: SyncRecycleStrategy) -> Self

Sets the per-checkout recycle strategy.

Source

pub fn wait_timeout(self, timeout: Option<Duration>) -> Self

Sets the maximum time get blocks waiting for a slot.

Source

pub fn max_lifetime(self, lifetime: Option<Duration>) -> Self

Sets the maximum lifetime of a physical connection.

Source

pub fn idle_timeout(self, timeout: Option<Duration>) -> Self

Sets the maximum idle time before a connection is retired at checkout.

Source

pub fn min_idle(self, min_idle: Option<u32>) -> Self

Sets the minimum number of idle connections to keep warm.

Source

pub fn build(self) -> ConnectionPool

Builds the synchronous connection pool. Connections are opened lazily on first ConnectionPool::get.

Trait Implementations§

Source§

impl Clone for SyncPoolConfig

Source§

fn clone(&self) -> SyncPoolConfig

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 SyncPoolConfig

Source§

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

Formats the value using the given formatter. Read more

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
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> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

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