Struct ClusterClient 

pub struct ClusterClient { /* private fields */ }

Available on crate feature cluster only.

A Redis Cluster client, used to create connections.

Implementations

impl ClusterClient

pub fn new<T: IntoConnectionInfo>( initial_nodes: impl IntoIterator<Item = T>, ) -> RedisResult<ClusterClient>

Creates a ClusterClient with the default parameters.

This does not create connections to the Redis Cluster, but only performs some basic checks on the initial nodes’ URLs and passwords/usernames.

Errors

Upon failure to parse initial nodes or if the initial nodes have different passwords or usernames, an error is returned.

pub fn builder<T: IntoConnectionInfo>( initial_nodes: impl IntoIterator<Item = T>, ) -> ClusterClientBuilder

Creates a ClusterClientBuilder with the provided initial_nodes.

pub fn get_connection(&self) -> RedisResult<ClusterConnection>

Creates new connections to Redis Cluster nodes and returns a cluster::ClusterConnection.

Errors

An error is returned if there is a failure while creating connections or slots.

pub fn get_connection_with_config( &self, config: ClusterConfig, ) -> RedisResult<ClusterConnection>

Creates new connections to Redis Cluster nodes with a custom config and returns a cluster_async::ClusterConnection.

Errors

An error is returned if there is a failure while creating connections or slots.

pub async fn get_async_connection(&self) -> RedisResult<ClusterConnection>

Available on crate feature cluster-async only.

Creates new connections to Redis Cluster nodes and returns a cluster_async::ClusterConnection.

Errors

An error is returned if there is a failure while creating connections or slots.

pub async fn get_async_connection_with_config( &self, config: ClusterConfig, ) -> RedisResult<ClusterConnection>

Available on crate feature cluster-async only.

Creates new connections to Redis Cluster nodes with a custom config and returns a cluster_async::ClusterConnection.

Errors

An error is returned if there is a failure while creating connections or slots.

pub fn get_pending_async_connection_with_config( &self, config: ClusterConfig, ) -> ClusterConnection

Available on crate feature cluster-async only.

Creates new connections to Redis Cluster nodes with a custom config and returns a cluster_async::ClusterConnection. The connections to the cluster nodes are done in the background so the caller won’t know if the cluster is available until the first command is sent.

Trait Implementations

impl Clone for ClusterClient

fn clone(&self) -> ClusterClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ManageConnection for ClusterClient

Available on crate feature r2d2 only.

type Connection = ClusterConnection

The connection type this manager deals with.

type Error = RedisError

The error type returned by Connections.

fn connect(&self) -> Result<Self::Connection, Self::Error>

Attempts to create a new connection.

fn is_valid(&self, conn: &mut Self::Connection) -> Result<(), Self::Error>

Determines if the connection is still connected to the database.

fn has_broken(&self, conn: &mut Self::Connection) -> bool

Quickly determines if the connection is no longer usable.

impl ManageConnection for ClusterClient

Available on crate features bb8 and aio only.

type Connection = ClusterConnection

The connection type this manager deals with.

type Error = RedisError

The error type returned by Connections.

async fn connect(&self) -> Result<Self::Connection, Self::Error>

Attempts to create a new connection.

async fn is_valid(&self, conn: &mut Self::Connection) -> Result<(), Self::Error>

Determines if the connection is still connected to the database.

fn has_broken(&self, _: &mut Self::Connection) -> bool

Synchronously determine if the connection is no longer usable, if possible.