Struct RedisCli 

pub struct RedisCli { /* private fields */ }

Builder for executing redis-cli commands.

Implementations

impl RedisCli

pub fn new() -> Self

Create a new redis-cli builder with defaults (localhost:6379).

pub fn bin(self, bin: impl Into<String>) -> Self

Set the redis-cli binary path.

pub fn host(self, host: impl Into<String>) -> Self

Set the host to connect to.

pub fn port(self, port: u16) -> Self

Set the port to connect to.

pub fn password(self, password: impl Into<String>) -> Self

Set the password for AUTH.

pub fn user(self, user: impl Into<String>) -> Self

Set the ACL username for AUTH.

pub fn db(self, db: u32) -> Self

Select a database number.

pub fn unixsocket(self, path: impl Into<PathBuf>) -> Self

Connect via a Unix socket instead of TCP.

pub fn tls(self, enable: bool) -> Self

Enable TLS for the connection.

pub fn sni(self, hostname: impl Into<String>) -> Self

Set the SNI hostname for TLS.

pub fn cacert(self, path: impl Into<PathBuf>) -> Self

Set the CA certificate file for TLS verification.

pub fn cert(self, path: impl Into<PathBuf>) -> Self

Set the client certificate file for TLS.

pub fn key(self, path: impl Into<PathBuf>) -> Self

Set the client private key file for TLS.

pub fn resp(self, protocol: RespProtocol) -> Self

Set the RESP protocol version.

pub fn cluster_mode(self, enable: bool) -> Self

Enable cluster mode (-c flag) for following redirects.

pub fn output_format(self, format: OutputFormat) -> Self

Set the output format.

pub fn no_auth_warning(self, suppress: bool) -> Self

Suppress the AUTH password warning.

pub async fn run(&self, args: &[&str]) -> Result<String>

Run a command and return stdout on success.

pub fn fire_and_forget(&self, args: &[&str])

Run a command, ignoring output. Used for fire-and-forget (SHUTDOWN).

pub async fn ping(&self) -> bool

Send PING and return true if PONG is received.

pub fn shutdown(&self)

Send SHUTDOWN NOSAVE. Best-effort.

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

Wait until the server responds to PING or timeout expires.

pub async fn cluster_create( &self, node_addrs: &[String], replicas_per_master: u16, ) -> Result<()>

Run redis-cli --cluster create ... to form a cluster.

Trait Implementations

impl Clone for RedisCli

fn clone(&self) -> RedisCli

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RedisCli

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

Formats the value using the given formatter.

impl Default for RedisCli

fn default() -> Self

Returns the “default value” for a type.