Struct ClusterConnection

pub struct ClusterConnection<C = MultiplexedConnection> { /* private fields */ }

This represents an async Redis Cluster connection.

It stores the underlying connections maintained for each node in the cluster, as well as common parameters for connecting to nodes and executing commands.

Implementations

impl<C> ClusterConnection<C>

where C: ConnectionLike + Connect + Clone + Send + Sync + Unpin + 'static,

pub async fn route_command( &mut self, cmd: &Cmd, routing: RoutingInfo, ) -> Result<Value, RedisError>

Send a command to the given routing, and aggregate the response according to response_policy.

pub async fn route_pipeline<'a>( &'a mut self, pipeline: &'a Pipeline, offset: usize, count: usize, route: SingleNodeRoutingInfo, ) -> Result<Vec<Value>, RedisError>

Send commands in pipeline to the given route. If route is None, it will be sent to a random node.

pub async fn subscribe( &mut self, channel_name: impl ToRedisArgs, ) -> Result<(), RedisError>

Subscribes to a new channel.

Updates from the sender will be sent on the push sender that was passed to the manager. If the manager was configured without a push sender, the connection won’t be able to pass messages back to the user..

This method is only available when the connection is using RESP3 protocol, and will return an error otherwise. It should be noted that the subscription will be automatically resubscribed after disconnections, so the user might receive additional pushes with [crate::PushKind::SSubcribe], later after the subscription completed.

pub async fn unsubscribe( &mut self, channel_name: impl ToRedisArgs, ) -> Result<(), RedisError>

Unsubscribes from channel.

This method is only available when the connection is using RESP3 protocol, and will return an error otherwise.

pub async fn psubscribe( &mut self, channel_pattern: impl ToRedisArgs, ) -> Result<(), RedisError>

Subscribes to a new channel pattern.

Updates from the sender will be sent on the push sender that was passed to the manager. If the manager was configured without a push sender, the manager won’t be able to pass messages back to the user..

This method is only available when the connection is using RESP3 protocol, and will return an error otherwise. It should be noted that the subscription will be automatically resubscribed after disconnections, so the user might receive additional pushes with [crate::PushKind::SSubcribe], later after the subscription completed.

pub async fn punsubscribe( &mut self, channel_pattern: impl ToRedisArgs, ) -> Result<(), RedisError>

Unsubscribes from channel pattern.

This method is only available when the connection is using RESP3 protocol, and will return an error otherwise.

pub async fn ssubscribe( &mut self, channel_name: impl ToRedisArgs, ) -> Result<(), RedisError>

Subscribes to a new sharded channel.

Updates from the sender will be sent on the push sender that was passed to the manager. If the manager was configured without a push sender, the manager won’t be able to pass messages back to the user..

This method is only available when the connection is using RESP3 protocol, and will return an error otherwise. It should be noted that the subscription will be automatically resubscribed after disconnections, so the user might receive additional pushes with [crate::PushKind::SSubcribe], later after the subscription completed.

pub async fn sunsubscribe( &mut self, channel_name: impl ToRedisArgs, ) -> Result<(), RedisError>

Unsubscribes from channel pattern.

This method is only available when the connection is using RESP3 protocol, and will return an error otherwise.

Trait Implementations

impl AsMut<ClusterConnection> for Connection

fn as_mut(&mut self) -> &mut ClusterConnection

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<ClusterConnection> for Connection

fn as_ref(&self) -> &ClusterConnection

Converts this type into a shared reference of the (usually inferred) input type.

impl<C> Clone for ClusterConnection<C>

where C: Clone,

fn clone(&self) -> ClusterConnection<C>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C> ConnectionLike for ClusterConnection<C>

where C: ConnectionLike + Send + Clone + Unpin + Sync + Connect + 'static,

fn req_packed_command<'a>( &'a mut self, cmd: &'a Cmd, ) -> Pin<Box<dyn Future<Output = Result<Value, RedisError>> + Send + 'a>>

Sends an already encoded (packed) command into the TCP socket and reads the single response from it.

fn get_db(&self) -> i64

Returns the database this connection is bound to. Note that this information might be unreliable because it’s initially cached and also might be incorrect if the connection like object is not actually connected.