Struct AsyncConnectionConfig

pub struct AsyncConnectionConfig { /* private fields */ }

Options for creation of async connection

Implementations

impl AsyncConnectionConfig

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 sender sender for push 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 = AsyncConnectionConfig::new().set_push_sender(tx);

let messages = Arc::new(Mutex::new(Vec::new()));
let config = AsyncConnectionConfig::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_tcp_settings(self, tcp_settings: TcpSettings) -> Self

Set the behavior of the underlying TCP connection.

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

Set the DNS resolver for the underlying TCP connection.

The parameter resolver must implement the [crate::aio::DNSResolver] trait.

Trait Implementations

impl Clone for AsyncConnectionConfig

fn clone(&self) -> AsyncConnectionConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for AsyncConnectionConfig

fn default() -> AsyncConnectionConfig

Returns the “default value” for a type.