Struct GlideClusterClientConfiguration 

#[non_exhaustive]
pub struct GlideClusterClientConfiguration {

    pub addresses: Vec<NodeAddress>,
    pub tls: TlsConfig,
    pub credentials: Option<ServerCredentials>,
    pub read_from: ReadFrom,
    pub request_timeout: Option<Duration>,
    pub connection_timeout: Option<Duration>,
    pub reconnect_strategy: Option<BackoffStrategy>,
    pub client_name: Option<String>,
    pub protocol: ProtocolVersion,
    pub periodic_checks: PeriodicChecks,
    pub inflight_requests_limit: Option<u32>,
    pub lazy_connect: bool,
    pub pubsub_subscriptions: Option<PubSubSubscriptions>,
    pub force_pubsub_channel: bool,
    pub root_certs: Vec<Vec<u8>>,
    pub client_identity: Option<ClientIdentity>,
}

Configuration for a cluster GLIDE client.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

addresses: Vec<NodeAddress>

Seed node addresses.

tls: TlsConfig

TLS mode.

credentials: Option<ServerCredentials>

Optional credentials.

read_from: ReadFrom

Read strategy.

request_timeout: Option<Duration>

Overall request timeout.

connection_timeout: Option<Duration>

Connection establishment timeout.

reconnect_strategy: Option<BackoffStrategy>

Reconnection backoff strategy.

client_name: Option<String>

Client name reported to the server.

protocol: ProtocolVersion

RESP protocol version.

periodic_checks: PeriodicChecks

Periodic topology checks.

inflight_requests_limit: Option<u32>

Maximum number of concurrent in-flight requests.

lazy_connect: bool

Defer connecting until the first command is issued.

pubsub_subscriptions: Option<PubSubSubscriptions>

Pub/Sub subscriptions to establish on connect.

force_pubsub_channel: bool

Force creation of the Pub/Sub push channel even when no subscriptions are configured, so runtime subscribe/unsubscribe can receive messages. See crate::commands::pubsub::PubSubCommands.

root_certs: Vec<Vec<u8>>

Custom CA certificate(s) (PEM bytes) to trust when verifying the server under TlsConfig::SecureTls. Lowered into ConnectionRequest::root_certs. Empty = use the system trust store.

client_identity: Option<ClientIdentity>

Client certificate + private key for mutual TLS. Set via Self::client_identity. Only meaningful together with TlsConfig::SecureTls.

Implementations

impl GlideClusterClientConfiguration

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

Configure for a single host:port.

pub fn tls(self, tls: TlsConfig) -> Self

Set TLS mode.

pub fn tls_ca_cert(self, pem: impl Into<Vec<u8>>) -> Self

Trust a custom CA certificate (PEM bytes) when verifying the server with TlsConfig::SecureTls. Enables secure TLS against a server presenting a certificate signed by a private/self-signed CA. May be called more than once to trust multiple CAs.

pub fn client_identity( self, cert_pem: impl Into<Vec<u8>>, key_pem: impl Into<Vec<u8>>, ) -> Self

Set a client certificate + private key (both PEM) for mutual TLS. The server must be configured to require/verify client certificates. Only meaningful together with TlsConfig::SecureTls.

pub fn credentials(self, creds: ServerCredentials) -> Self

Set credentials.

pub fn read_from(self, read_from: ReadFrom) -> Self

Set read strategy.

pub fn request_timeout(self, timeout: Duration) -> Self

Set request timeout.

pub fn connection_timeout(self, timeout: Duration) -> Self

Set the connection-establishment timeout.

pub fn inflight_requests_limit(self, limit: u32) -> Self

Set the maximum number of concurrent in-flight requests.

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

Set client name.

pub fn protocol(self, protocol: ProtocolVersion) -> Self

Set protocol version.

pub fn lazy_connect(self, lazy: bool) -> Self

Enable lazy connection.

pub fn reconnect_strategy(self, strategy: BackoffStrategy) -> Self

Set reconnection strategy.

pub fn subscriptions(self, subscriptions: PubSubSubscriptions) -> Self

Set Pub/Sub subscriptions to establish on connect.

pub fn enable_pubsub(self) -> Self

Enable the Pub/Sub push channel without configuring any connect-time subscriptions, so the client can use runtime subscribe/unsubscribe and receive messages via get_pubsub_message. Connect-time subscriptions enable this implicitly.

Note: runtime subscriptions are session-scoped — unlike connect-time subscriptions they are not automatically restored after a reconnect.

impl GlideClusterClientConfiguration

pub fn new(addresses: Vec<NodeAddress>) -> Self

Create a cluster configuration for the given addresses.

pub fn from_url(url: impl AsRef<str>) -> ValkeyResult<Self>

Build a configuration from a connection URL.

Supports Redis URLs:

use glide::GlideClusterClientConfiguration;
let url = "redis://user:pass@localhost:6379";
let cfg = GlideClusterClientConfiguration::from_url(url).unwrap();
assert_eq!(cfg.addresses.len(), 1);

rediss:// enables TLS with full verification; rediss://…/#insecure disables certificate verification.

Does not support Unix-socket URLs (unix:// or unix+redis://). Does not support Valkey URLs (valkey:// or valkeys://).

pub fn from_urls<S: AsRef<str>>( urls: impl IntoIterator<Item = S>, ) -> ValkeyResult<Self>

Build a configuration from one or more connection URL.

Configuration must be identical across all URLs: conflicting settings are rejected with a configuration error. A URL selecting a non-zero database is also rejected because clusters only support database 0.

The RESP protocol is taken from the first URL and not cross-validated.

Supports Redis URLs:

use glide::GlideClusterClientConfiguration;
let urls = ["redis://user:pass@localhost:6379", "redis://user:pass@localhost:6380"];
let cfg = GlideClusterClientConfiguration::from_urls(urls).unwrap();
assert_eq!(cfg.addresses.len(), 2);

rediss:// enables TLS with full verification; rediss://…/#insecure disables certificate verification.

Does not support Unix-socket URLs (unix:// or unix+redis://). Does not support Valkey URLs (valkey:// or valkeys://).

pub fn periodic_checks(self, checks: PeriodicChecks) -> Self

Set periodic checks.

Trait Implementations

impl Clone for GlideClusterClientConfiguration

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GlideClusterClientConfiguration

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

Formats the value using the given formatter.