Enum fred::types::ServerConfig

pub enum ServerConfig {
    Centralized {
        server: Server,
    },
    Clustered {
        hosts: Vec<Server>,
        policy: ClusterDiscoveryPolicy,
    },
    Unix {
        path: PathBuf,
    },
    Sentinel {
        hosts: Vec<Server>,
        service_name: String,
        username: Option<String>,
        password: Option<String>,
    },
}

Connection configuration for the Redis server.

Variants

Centralized

Fields

server: Server

The Server identifier.

Clustered

Fields

hosts: Vec<Server>

The known cluster node Server identifiers.

Only one node in the cluster needs to be provided here, the rest will be discovered via the CLUSTER SLOTS command.

policy: ClusterDiscoveryPolicy

The cluster discovery policy to use when connecting or following redirections.

Unix

Available on crate feature unix-sockets only.

Fields

path: PathBuf

The path to the Unix socket.

Any associated Server identifiers will use this value as the host.

Sentinel

Fields

hosts: Vec<Server>

An array of Server identifiers for each known sentinel instance.

service_name: String

The service name for primary/main instances.

username: Option<String>

Available on crate feature sentinel-auth only.

An optional ACL username for the client to use when authenticating.

password: Option<String>

Available on crate feature sentinel-auth only.

An optional password for the client to use when authenticating.

Implementations

impl ServerConfig

pub fn new_centralized<S>(host: S, port: u16) -> ServerConfig

where S: Into<String>,

Create a new centralized config with the provided host and port.

pub fn new_clustered<S>(hosts: Vec<(S, u16)>) -> ServerConfig

where S: Into<String>,

Create a new clustered config with the provided set of hosts and ports.

Only one valid host in the cluster needs to be provided here. The client will use CLUSTER NODES to discover the other nodes.

pub fn new_sentinel<H, N>(hosts: Vec<(H, u16)>, service_name: N) -> ServerConfig

where H: Into<String>, N: Into<String>,

Create a new sentinel config with the provided set of hosts and the name of the service.

This library will connect using the details from the Redis documentation.

pub fn new_unix_socket<P>(path: P) -> ServerConfig

where P: Into<PathBuf>,

Available on crate feature unix-sockets only.

Create a new server config for a connected Unix socket.

pub fn default_centralized() -> ServerConfig

Create a centralized config with default settings for a local deployment.

pub fn default_clustered() -> ServerConfig

Create a clustered config with the same defaults as specified in the create-cluster script provided by Redis.

pub fn is_clustered(&self) -> bool

Whether the config uses a clustered deployment.

pub fn is_sentinel(&self) -> bool

Whether the config is for a centralized server behind a sentinel node(s).

pub fn is_centralized(&self) -> bool

Whether the config is for a centralized server.

pub fn is_unix_socket(&self) -> bool

Whether the config uses a Unix socket.

pub fn hosts(&self) -> Vec<Server>

Read the server hosts or sentinel hosts if using the sentinel interface.

pub fn set_cluster_discovery_policy( &mut self, new_policy: ClusterDiscoveryPolicy ) -> Result<(), RedisError>

Set the ClusterDiscoveryPolicy, if possible.

Trait Implementations

impl Clone for ServerConfig

fn clone(&self) -> ServerConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ServerConfig

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

Formats the value using the given formatter.

impl Default for ServerConfig

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for ServerConfig

fn eq(&self, other: &ServerConfig) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for ServerConfig

impl StructuralPartialEq for ServerConfig