Struct ClusterConfig

pub struct ClusterConfig { /* private fields */ }

Available on crate feature cluster only.

Options for creation of connection

Implementations

impl ClusterConfig

pub fn new() -> Self

Creates a new instance of the options with nothing set

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

Sets the connection timeout

pub fn set_response_timeout(self, response_timeout: Duration) -> Self

Sets the response timeout

pub fn set_push_sender(self, sender: impl AsyncPushSender) -> Self

Sets a sender to receive pushed values.

The sender can be a channel, or an arbitrary function that handles crate::PushInfo values. This will fail client creation if the connection isn’t configured for RESP3 communications via the crate::RedisConnectionInfo::protocol field.

Examples

let (tx, mut rx) = tokio::sync::mpsc::unbounded_channel();
let config = ClusterConfig::new().set_push_sender(tx);

let messages = Arc::new(Mutex::new(Vec::new()));
let config = ClusterConfig::new().set_push_sender(move |msg|{
    let Ok(mut messages) = messages.lock() else {
        return Err(redis::aio::SendError);
    };
    messages.push(msg);
    Ok(())
});

pub fn set_dns_resolver(self, resolver: impl AsyncDNSResolver) -> Self

Set asynchronous DNS resolver for the underlying TCP connection.

The parameter resolver must implement the crate::io::AsyncDNSResolver trait.

Trait Implementations

impl Clone for ClusterConfig

fn clone(&self) -> ClusterConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for ClusterConfig

fn default() -> ClusterConfig

Returns the “default value” for a type.