Struct Config 

pub struct Config {

    pub server: ServerConfig,
    pub username: Option<String>,
    pub password: Option<String>,
    pub database: usize,
    pub tls_config: Option<TlsConfig>,
    pub connect_timeout: Duration,
    pub command_timeout: Duration,
    pub auto_resubscribe: bool,
    pub auto_remonitor: bool,
    pub connection_name: String,
    pub keep_alive: Option<Duration>,
    pub no_delay: bool,
    pub retry_on_error: bool,
    pub reconnection: ReconnectionConfig,
}

Configuration options for a client or a pooled client

Fields

server: ServerConfig

Connection server configuration (standalone, sentinel, or cluster)

username: Option<String>

An optional ACL username for authentication.

See ACL

password: Option<String>

An optional password for authentication.

The password could be either coupled with an ACL username either used alone.

See:

• ACL
• Authentication

database: usize

The default database for this connection.

If database is not set to 0, a SELECT command will be automatically issued at connection or reconnection.

tls_config: Option<TlsConfig>

Available on crate features native-tls or rustls only.

An optional TLS configuration.

connect_timeout: Duration

The time to attempt a connection before timing out. The default is 10 seconds

command_timeout: Duration

If a command does not return a reply within a set number of milliseconds, a timeout error will be thrown.

If set to 0, no timeout is apply

The default is 0

auto_resubscribe: bool

When the client reconnects, channels subscribed in the previous connection will be resubscribed automatically if auto_resubscribe is true.

The default is true

auto_remonitor: bool

When the client reconnects, if in monitor mode, the monitor command will be resent automatically

The default is true

connection_name: String

Set the name of the connection to make it easier to identity the connection in client list.

See client_setname

keep_alive: Option<Duration>

Enable/disable keep-alive functionality (default None)

See TcpKeepAlive::with_time

no_delay: bool

Enable/disable the use of Nagle’s algorithm (default true)

See TcpStream::set_nodelay

retry_on_error: bool

Defines the default strategy for retries on network error (default false):

• true - retry sending the command/batch of commands on network error
• false - do not retry sending the command/batch of commands on network error

This strategy can be overriden for each command/batch of commands in the following functions:

• PreparedCommand::retry_on_error
• Pipeline::retry_on_error
• Transaction::retry_on_error
• Client::send
• Client::send_and_forget
• Client::send_batch

reconnection: ReconnectionConfig

Reconnection policy configuration (Constant, Linear or Exponential)

Implementations

impl Config

pub fn from_uri(uri: Url) -> Result<Config>

Build a config from an URI in the format redis[s]://[[username]:password@]host[:port]/[database]

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.

impl Display for Config

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

Formats the value using the given formatter.

impl FromStr for Config

fn from_str(str: &str) -> Result<Config>

Build a config from an URI or a standard address format host:port

type Err = Error

The associated error which can be returned from parsing.

impl IntoConfig for Config

fn into_config(self) -> Result<Config>

Converts this type into a Config.