Struct ConnectionPool 

pub struct ConnectionPool { /* private fields */ }

A connection pool. Clones are cheap and is the expected way to send the pool around your application.

Implementations

impl ConnectionPool

pub async fn create( address: String, password: Option<&str>, connection_count: usize, ) -> Result<Self>

Create a new connection pool for address, with connection_count connections. All connections are created in this function, and depending on the amount of connections desired, can therefore take some time to complete. By default, connections will be created with the name darkredis-n, where n represents the connection number.

Panics

Will panic if the number of connections is equal to zero.

pub async fn create_with_name( name: &str, address: String, password: Option<&str>, connection_count: usize, ) -> Result<Self>

Create a connection pool, but name each connection by name. Useful if you are running multiple services on a single Redis instance.

Panics

Will panic if the number of connections is equal to zero.

pub async fn get(&self) -> MutexGuard<'_, Connection>

Get an available connection from the pool, or wait for one to become available if none are available.

pub async fn spawn<'a, N>(&'a self, name: N) -> Result<Connection>

where N: Into<Option<&'a str>>,

Create a new, owned connection using the settings of the current pool. Useful for subscribers or blocking operations that may not yield a value for a long time.

Trait Implementations

impl Clone for ConnectionPool

fn clone(&self) -> ConnectionPool

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConnectionPool

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

Formats the value using the given formatter.