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 cacertdir(self, path: impl Into<PathBuf>) -> Self

Set the CA certificate directory for TLS verification.

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

Skip TLS certificate verification (--insecure).

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

Set the allowed TLS 1.2 ciphers (--tls-ciphers).

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

Set the allowed TLS 1.3 ciphersuites (--tls-ciphersuites).

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

Set the server URI (-u), e.g. redis://user:pass@host:port/db.

pub fn timeout(self, seconds: f64) -> Self

Set the connection timeout in seconds (-t).

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

Prompt for password from stdin (--askpass).

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

Set the client connection name (--name).

pub fn ip_preference(self, preference: IpPreference) -> Self

Set IP version preference for connections.

pub fn repeat(self, count: u32) -> Self

Execute the command N times (-r).

pub fn interval(self, seconds: f64) -> Self

Set interval in seconds between repeated commands (-i).

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 fn stdin_last_arg(self, enable: bool) -> Self

Read last argument from stdin (-x).

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

Read tag argument from stdin (-X).

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

Set the multi-bulk delimiter (-d).

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

Set the output delimiter between responses (-D).

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

Return exit error code on server errors (-e).

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

Force formatted output even with pipe (--no-raw).

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

Force input to be processed as quoted strings (--quoted-input).

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

Show or hide push messages (--show-pushes).

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

Enable continuous stat mode (--stat).

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

Enable latency mode (--latency).

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

Enable latency history mode (--latency-history).

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

Enable latency distribution mode (--latency-dist).

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

Scan for big keys (--bigkeys).

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

Scan for keys by memory usage (--memkeys).

pub fn memkeys_samples(self, n: u32) -> Self

Set the sample count for memkeys (--memkeys-samples).

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

Enable key statistics (--keystats).

pub fn keystats_samples(self, n: u32) -> Self

Set the sample count for keystats (--keystats-samples).

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

Scan for hot keys (--hotkeys).

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

Enable scan mode (--scan).

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

Set a pattern filter for scan (--pattern).

pub fn count(self, n: u32) -> Self

Set a count hint for scan (--count).

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

Set a quoted pattern for scan (--quoted-pattern).

pub fn cursor(self, n: u64) -> Self

Set the starting cursor for scan (--cursor).

pub fn top(self, n: u32) -> Self

Set the top N for keystats (--top).

pub fn intrinsic_latency(self, seconds: u32) -> Self

Measure intrinsic system latency for the given number of seconds.

pub fn lru_test(self, keys: u64) -> Self

Run LRU simulation test with the given number of keys.

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

Enable verbose mode (--verbose).

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

Evaluate a Lua script file (--eval).

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

Enable Lua debugger (--ldb).

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

Enable Lua debugger in synchronous mode (--ldb-sync-mode).

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

Enable pipe mode for mass-insert (--pipe).

pub fn pipe_timeout(self, seconds: u32) -> Self

Set the pipe mode timeout in seconds (--pipe-timeout).

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

Transfer an RDB dump to a file (--rdb).

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

Transfer a functions-only RDB dump (--functions-rdb).

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

Simulate a replica for replication stream (--replica).

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

Run a redis-cli --cluster <command> subcommand.

This is a general-purpose method for all cluster subcommands beyond create (which has the dedicated cluster_create method). Pass the subcommand and any additional arguments.

Example

use redis_server_wrapper::RedisCli;

let cli = RedisCli::new().host("127.0.0.1").port(7000);
let info = cli.cluster_command("info", &["127.0.0.1:7000"]).await.unwrap();

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.