Struct RedisClusterHandle 

pub struct RedisClusterHandle { /* private fields */ }

A running Redis Cluster. Stops all nodes on Drop.

Implementations

impl RedisClusterHandle

pub fn addr(&self) -> String

The seed address (first node).

pub fn node_addrs(&self) -> Vec<String>

All node addresses.

pub fn pids(&self) -> Vec<u32>

The PIDs of all redis-server processes in the cluster.

pub async fn all_alive(&self) -> bool

Check if all nodes are alive.

pub async fn is_healthy(&self) -> bool

Check CLUSTER INFO for state=ok and all slots assigned.

pub async fn wait_for_healthy(&self, timeout: Duration) -> Result<()>

Wait until the cluster is healthy or timeout.

pub fn node(&self, index: usize) -> &RedisServerHandle

Access a specific node by index.

Nodes are ordered by port: masters first (indices 0..masters), then replicas (indices masters..total).

Panics

Panics if index >= total_nodes.

pub fn nodes(&self) -> &[RedisServerHandle]

All node handles.

pub fn num_masters(&self) -> u16

The number of master nodes in the cluster.

pub fn master_nodes(&self) -> &[RedisServerHandle]

Handles for the master nodes (the first masters nodes by port order).

Note: this reflects the initial topology. After a failover, the actual roles may differ from the startup ordering.

pub fn replica_nodes(&self) -> &[RedisServerHandle]

Handles for the replica nodes (all nodes after the masters by port order).

Note: this reflects the initial topology. After a failover, the actual roles may differ from the startup ordering.

pub async fn config_set_all(&self, key: &str, value: &str) -> Result<()>

Run CONFIG SET on all nodes.

pub async fn config_set_masters(&self, key: &str, value: &str) -> Result<()>

Run CONFIG SET on master nodes only (initial topology).

pub async fn config_set_replicas(&self, key: &str, value: &str) -> Result<()>

Run CONFIG SET on replica nodes only (initial topology).

pub fn cli(&self) -> RedisCli

Get a RedisCli for the seed node.

Trait Implementations

impl Drop for RedisClusterHandle

fn drop(&mut self)

Executes the destructor for this type.