Struct Options 

pub struct Options {
    pub idle_timeout: Duration,
    pub connect_timeout: Duration,
    pub max_connections: usize,
    pub on_connected: Option<Arc<dyn Fn(&Endpoint, &Connection) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send>> + Sync + Send>>,
}

Configuration options for the connection pool

Fields

idle_timeout: Duration

How long to keep idle connections around.

connect_timeout: Duration

Timeout for connect. This includes the time spent in on_connect, if set.

max_connections: usize

Maximum number of connections to hand out.

on_connected: Option<Arc<dyn Fn(&Endpoint, &Connection) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send>> + Sync + Send>>

An optional callback that can be used to wait for the connection to enter some state. An example usage could be to wait for the connection to become direct before handing it out to the user.

Implementations

impl Options

pub fn with_on_connected<F, Fut>(self, f: F) -> Options

where F: Fn(Endpoint, Connection) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<(), Error>> + Send + 'static,

Set the on_connected callback

Trait Implementations

impl Clone for Options

fn clone(&self) -> Options

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Options

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

Formats the value using the given formatter.

impl Default for Options

fn default() -> Options

Returns the “default value” for a type.