Struct RedisServer 

pub struct RedisServer { /* private fields */ }

Builder for a Redis server.

Implementations

impl RedisServer

pub fn new() -> Self

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

Set the listening port (default: 6379).

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

Set the bind address (default: 127.0.0.1).

pub fn protected_mode(self, protected: bool) -> Self

Enable or disable protected mode (default: off).

pub fn tcp_backlog(self, backlog: u32) -> Self

Set the TCP backlog queue length.

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

Set a Unix socket path for connections.

pub fn unixsocketperm(self, perm: u32) -> Self

Set Unix socket permissions (e.g. 700).

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

Close idle client connections after this many seconds (0 = disabled).

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

Set TCP keepalive interval in seconds.

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

Set TLS listening port.

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

Set the TLS certificate file path.

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

Set the TLS private key file path.

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

Set the TLS CA certificate file path.

pub fn tls_auth_clients(self, require: bool) -> Self

Require TLS client authentication.

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

Set the working directory for data files.

pub fn loglevel(self, level: LogLevel) -> Self

Set the log level (default: LogLevel::Notice).

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

Set the number of databases (default: 16).

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

Set the maximum memory limit (e.g. "256mb", "1gb").

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

Set the eviction policy when maxmemory is reached.

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

Set the maximum number of simultaneous client connections.

pub fn save(self, save: bool) -> Self

Enable or disable RDB snapshots (default: off).

pub fn appendonly(self, appendonly: bool) -> Self

Enable or disable AOF persistence.

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

Configure this server as a replica of the given master.

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

Set the password for authenticating with a master.

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

Set a requirepass password for client connections.

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

Set the path to an ACL file.

pub fn cluster_enabled(self, enabled: bool) -> Self

Enable Redis Cluster mode.

pub fn cluster_node_timeout(self, ms: u64) -> Self

Set the cluster node timeout in milliseconds.

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

Load a Redis module at startup.

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

Set the server tick frequency in Hz (default: 10).

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

Set the number of I/O threads.

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

Enable I/O threads for reads as well as writes.

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

Set keyspace notification events (e.g. "KEA").

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

Set a custom redis-server binary path.

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

Set a custom redis-cli binary path.

pub fn extra(self, key: impl Into<String>, value: impl Into<String>) -> Self

Set an arbitrary config directive not covered by dedicated methods.

pub async fn start(self) -> Result<RedisServerHandle>

Start the server. Returns a handle that stops the server on Drop.

Verifies that redis-server and redis-cli binaries are available before attempting to launch anything.

Trait Implementations

impl Default for RedisServer

fn default() -> Self

Returns the “default value” for a type.