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
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
use std::fmt;
use std::time::Duration;

use crate::{Immediately, Millis, Seconds, Wait};

/// Various options on retrieving a connection
/// that can be applied if a user wants to use the pool defaults
/// for retrieving a connection.
///
/// The default is to wait for 30ms.
///
/// This struct only slightly differs from `CheckoutMode`: It lacks
/// the variant `PoolDefault` since that variant would make no sense
/// as this enum describes the default behaviour of the pool.
///
/// This struct has the same behaviour as `CheckoutMode` regarding its
/// `From` implementations.
///
/// The default is to wait for 30ms.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum DefaultPoolCheckoutMode {
    /// Expect a connection to be returned immediately.
    /// If there is none available return an error immediately.
    Immediately,
    /// Wait until there is a connection.
    ///
    /// Using this can be risky as connections are returned
    /// when dropped. If the pool has no idle connections left while
    /// none are returned a deadlock might occur. It is always safe to use
    /// this mode if  only the `RedisPool` itself is used as a connection since
    /// it will immediately return the used connection after each operation.
    Wait,
    /// Wait for at most the given `Duration`.
    ///
    /// The amount of time waited will in the end not be really exact.
    WaitAtMost(Duration),
}

impl Default for DefaultPoolCheckoutMode {
    fn default() -> Self {
        DefaultPoolCheckoutMode::WaitAtMost(Duration::from_millis(30))
    }
}

impl std::str::FromStr for DefaultPoolCheckoutMode {
    type Err = ParseDefaultPoolCheckoutModeError;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        match &*s.to_lowercase() {
            "wait" => Ok(DefaultPoolCheckoutMode::Wait),
            "immediately" => Ok(DefaultPoolCheckoutMode::Immediately),
            milliseconds => Ok(DefaultPoolCheckoutMode::WaitAtMost(Duration::from_millis(
                milliseconds
                    .parse::<u64>()
                    .map_err(|err| ParseDefaultPoolCheckoutModeError(err.to_string()))?,
            ))),
        }
    }
}

impl From<Immediately> for DefaultPoolCheckoutMode {
    fn from(_: Immediately) -> Self {
        DefaultPoolCheckoutMode::Immediately
    }
}

impl From<Wait> for DefaultPoolCheckoutMode {
    fn from(_: Wait) -> Self {
        DefaultPoolCheckoutMode::Wait
    }
}

impl From<Duration> for DefaultPoolCheckoutMode {
    fn from(d: Duration) -> Self {
        if d != Duration::from_secs(0) {
            DefaultPoolCheckoutMode::WaitAtMost(d)
        } else {
            DefaultPoolCheckoutMode::Immediately
        }
    }
}

impl From<Millis> for DefaultPoolCheckoutMode {
    fn from(d: Millis) -> Self {
        DefaultPoolCheckoutMode::WaitAtMost(d.into())
    }
}

impl From<Seconds> for DefaultPoolCheckoutMode {
    fn from(d: Seconds) -> Self {
        DefaultPoolCheckoutMode::WaitAtMost(d.into())
    }
}

#[derive(Debug)]
pub struct ParseDefaultPoolCheckoutModeError(String);

impl fmt::Display for ParseDefaultPoolCheckoutModeError {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(
            f,
            "Could not parse ParseDefaultPoolCheckoutMode: {}",
            self.0
        )
    }
}

impl std::error::Error for ParseDefaultPoolCheckoutModeError {
    fn description(&self) -> &str {
        "parse default pool checkout mode failed"
    }

    fn cause(&self) -> Option<&dyn std::error::Error> {
        None
    }
}

/// A timeout for commands which is applied to all commands on all connections.
///
/// This timeout is a default and can be overridden in several places to
/// adjust the behaviour.
///
/// The default is to timeout after 1 minute.
///
/// ## FromStr
///
/// ```rust
/// # use std::time::Duration;
/// use reool::config::DefaultCommandTimeout;
///
/// let never: DefaultCommandTimeout = "never".parse().unwrap();
/// assert_eq!(never, DefaultCommandTimeout::Never);
///
/// let after100ms: DefaultCommandTimeout = "100".parse().unwrap();
/// assert_eq!(after100ms, DefaultCommandTimeout::After(Duration::from_millis(100)));
/// ```
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum DefaultCommandTimeout {
    /// Never time out.
    ///
    /// This requires a timeout to be applied from externally unless
    /// it is guaranted that a connection is killed eventually.
    Never,
    /// Wait for at most the given `Duration` until a
    /// Redis command has finished.
    ///
    /// If elapsed abort (drop) the connection.
    After(Duration),
}

impl DefaultCommandTimeout {
    pub fn to_duration_opt(self) -> Option<Duration> {
        match self {
            DefaultCommandTimeout::Never => None,
            DefaultCommandTimeout::After(dur) => Some(dur),
        }
    }
}

impl Default for DefaultCommandTimeout {
    fn default() -> Self {
        DefaultCommandTimeout::After(Duration::from_secs(60))
    }
}

impl std::str::FromStr for DefaultCommandTimeout {
    type Err = ParseDefaultCommandTimeoutError;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        match &*s.to_lowercase() {
            "never" => Ok(DefaultCommandTimeout::Never),
            milliseconds => Ok(DefaultCommandTimeout::After(Duration::from_millis(
                milliseconds
                    .parse::<u64>()
                    .map_err(|err| ParseDefaultCommandTimeoutError(err.to_string()))?,
            ))),
        }
    }
}

impl From<Wait> for DefaultCommandTimeout {
    fn from(_: Wait) -> Self {
        DefaultCommandTimeout::Never
    }
}

impl From<Millis> for DefaultCommandTimeout {
    fn from(d: Millis) -> Self {
        DefaultCommandTimeout::After(d.into())
    }
}

impl From<Seconds> for DefaultCommandTimeout {
    fn from(d: Seconds) -> Self {
        DefaultCommandTimeout::After(d.into())
    }
}

impl From<Duration> for DefaultCommandTimeout {
    fn from(d: Duration) -> Self {
        DefaultCommandTimeout::After(d)
    }
}

#[derive(Debug)]
pub struct ParseDefaultCommandTimeoutError(String);

impl fmt::Display for ParseDefaultCommandTimeoutError {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(
            f,
            "Could not parse ParseDefaultCommandTimeoutError: {}",
            self.0
        )
    }
}

impl std::error::Error for ParseDefaultCommandTimeoutError {
    fn description(&self) -> &str {
        "parse default command timeout failed"
    }

    fn cause(&self) -> Option<&dyn std::error::Error> {
        None
    }
}