Struct mobc::Builder

pub struct Builder<M> { /* private fields */ }

A builder for a connection pool.

Implementations

impl<M: Manager> Builder<M>

pub fn new() -> Self

Constructs a new Builder.

Parameters are initialized with their default values.

pub fn max_open(self, max_open: u64) -> Self

Sets the maximum number of connections managed by the pool.

• 0 means unlimited.
• Defaults to 10.

pub fn max_idle(self, max_idle: u64) -> Self

Sets the maximum idle connection count maintained by the pool.

The pool will maintain at most this many idle connections at all times, while respecting the value of max_open.

• Defaults to 2.

pub fn test_on_check_out(self, health_check: bool) -> Builder<M>

If true, the health of a connection will be verified via a call to Manager::check before it is checked out of the pool.

• Defaults to true.

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

Sets the maximum lifetime of connections in the pool.

Expired connections may be closed lazily before reuse.

• None means reuse forever.
• Defaults to None.

Panics

Panics if max_lifetime is the zero Duration.

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

Sets the maximum lifetime of connection to be idle in the pool, resetting the timer when connection is used.

Expired connections may be closed lazily before reuse.

• None means reuse forever.
• Defaults to None.

Panics

Panics if max_idle_lifetime is the zero Duration.

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

Sets the get timeout used by the pool.

Calls to Pool::get will wait this long for a connection to become available before returning an error.

• None means never timeout.
• Defaults to 30 seconds.

Panics

Panics if connection_timeout is the zero duration

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

Sets the interval how often a connection will be checked when returning an existing connection from the pool. If set to None, a connection is checked every time when returning from the pool. Must be used together with test_on_check_out set to true, otherwise does nothing.

• None means a connection is checked every time when returning from the pool.
• Defaults to None.

Panics

Panics if connection_timeout is the zero duration

pub fn build(self, manager: M) -> Pool<M>

Consumes the builder, returning a new, initialized pool.

Panics

Panics if max_idle is greater than max_size.

Trait Implementations

impl<M> Default for Builder<M>

fn default() -> Self

Returns the “default value” for a type.