redis-async 0.18.0

An asynchronous futures based Redis client for Rust using Tokio
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89

/*
 * Copyright 2020-2025 Ben Ashford
 *
 * Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
 * http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
 * <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
 * option. This file may not be copied, modified, or distributed
 * except according to those terms.
 */

use std::sync::Arc;
use std::time::Duration;

use crate::{error, reconnect::ReconnectOptions};

#[derive(Debug)]
/// Connection builder
pub struct ConnectionBuilder {
    pub(crate) host: String,
    pub(crate) port: u16,
    pub(crate) username: Option<Arc<str>>,
    pub(crate) password: Option<Arc<str>>,
    pub(crate) reconnect_options: ReconnectOptions,
    #[cfg(feature = "tls")]
    pub(crate) tls: bool,
    pub(crate) socket_keepalive: Option<Duration>,
    pub(crate) socket_timeout: Option<Duration>,
}

const DEFAULT_KEEPALIVE: Duration = Duration::from_secs(60);
const DEFAULT_TIMEOUT: Duration = Duration::from_secs(30);

impl ConnectionBuilder {
    pub fn new(host: impl Into<String>, port: u16) -> Result<Self, error::Error> {
        Ok(Self {
            host: host.into(),
            port,
            username: None,
            password: None,
            reconnect_options: ReconnectOptions::default(),
            #[cfg(feature = "tls")]
            tls: false,
            socket_keepalive: Some(DEFAULT_KEEPALIVE),
            socket_timeout: Some(DEFAULT_TIMEOUT),
        })
    }

    /// Set the username used when connecting
    pub fn password<V: Into<Arc<str>>>(&mut self, password: V) -> &mut Self {
        self.password = Some(password.into());
        self
    }

    /// Set the password used when connecting
    pub fn username<V: Into<Arc<str>>>(&mut self, username: V) -> &mut Self {
        self.username = Some(username.into());
        self
    }

    #[cfg(feature = "tls")]
    pub fn tls(&mut self) -> &mut Self {
        self.tls = true;
        self
    }

    /// Set the socket keepalive duration
    pub fn socket_keepalive(&mut self, duration: Option<Duration>) -> &mut Self {
        self.socket_keepalive = duration;
        self
    }

    /// Set the socket timeout duration
    pub fn socket_timeout(&mut self, duration: Option<Duration>) -> &mut Self {
        self.socket_timeout = duration;
        self
    }

    /// Set the reconnect timeout
    pub fn reconnect_timeout(&mut self, duration: Duration) -> &mut Self {
        self.reconnect_options.connection_timeout = duration;
        self
    }

    /// Set the number of reconnection attempts
    pub fn reconnect_attempts(&mut self, attempts: u64) -> &mut Self {
        self.reconnect_options.max_connection_attempts = attempts;
        self
    }
}