ClusterClient in redis::cluster - Rust
Description: A Redis Cluster client, used to create connections.

Skip to main content

## ClusterClient

# Struct ClusterClient

Source

    pub struct ClusterClient { /* private fields */ }

Available on crate feature `cluster` only.
Expand description

A Redis Cluster client, used to create connections.

## Implementations§

Source§

### impl ClusterClient

Source

#### 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.

Source

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

Creates a `ClusterClientBuilder` with the provided initial_nodes.

Source

#### 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.

Source

#### 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.

Source

#### 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.

Source

#### 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.

Source

#### 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§

Source§

### impl Clone for ClusterClient

Source§

#### fn clone(&self) -> ClusterClient

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from `source`. Read more
Source§

### impl ManageConnection for ClusterClient

Available on crate feature `r2d2` only.
Source§

#### type Connection = ClusterConnection

The connection type this manager deals with.
Source§

#### type Error = RedisError

The error type returned by `Connection`s.
Source§

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

Attempts to create a new connection.
Source§

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

Determines if the connection is still connected to the database. Read more
Source§

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

Quickly determines if the connection is no longer usable. Read more
Source§

### impl ManageConnection for ClusterClient

Available on crate features `bb8` and `aio` only.
Source§

#### type Connection = ClusterConnection

The connection type this manager deals with.
Source§

#### type Error = RedisError

The error type returned by `Connection`s.
Source§

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

Attempts to create a new connection.
Source§

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

Determines if the connection is still connected to the database.
Source§

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

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

## Auto Trait Implementations§

§

### impl Freeze for ClusterClient

§

### impl !RefUnwindSafe for ClusterClient

§

### impl Send for ClusterClient

§

### impl Sync for ClusterClient

§

### impl Unpin for ClusterClient

§

### impl !UnwindSafe for ClusterClient

## 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> DynClone for T
where T: Clone,

Source§

#### fn __clone_box(&self, _: Private) -> *mut ()

Source§

### impl<T> From<T> for T

Source§

#### fn from(t: T) -> T

Returns the argument unchanged.

§

### impl<T> Instrument for T

§

#### fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [`Span`], returning an `Instrumented` wrapper. Read more
§

#### 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.

§

### impl<T> PolicyExt for T
where T: ?Sized,

§

#### fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new `Policy` that returns [`Action::Follow`] only if `self` and `other` return `Action::Follow`. Read more
§

#### fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new `Policy` that returns [`Action::Follow`] if either `self` or `other` returns `Action::Follow`. Read more
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.
§

### impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

#### fn vzip(self) -> V

§

### impl<T> WithSubscriber for T

§

#### 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
§

#### fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default `Subscriber` to this type, returning a [`WithDispatch`] wrapper. Read more
§

### impl<T> ErasedDestructor for T
where T: 'static,

§

### impl<T> MaybeSendSync for T