redsync 1.0.1

A Rust implementation of Redlock for distributed locks with Redis
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

use std::fmt;
use std::ops::{Deref, DerefMut};

use thiserror::Error;

/// `RedsyncError` is an enum of all error kinds returned by the crate.
#[derive(Error, Debug, PartialEq)]
pub enum RedsyncError {
    #[error("{0}")]
    RedisError(#[from] redis::RedisError),
    #[error("unexpected response from Redis: {0:?}")]
    UnexpectedResponse(redis::Value),

    #[error("requested resource is current locked")]
    ResourceLocked,
    #[error("invalid or expired lease on lock")]
    InvalidLease,

    #[error("lock attempt failed: max retries exceeded: {0}")]
    LockRetriesExceeded(MultiError),
    #[error("extend attempt failed: max retries exceeded: {0}")]
    ExtendRetriesExceeded(MultiError),
    #[error("unlock attempt failed: {0}")]
    UnlockFailed(MultiError),
}

/// `MultiError` wraps `Vec<RedsyncError>`, typically aggregated over instances in a Redsync cluster.
#[derive(Debug, Default, PartialEq)]
pub struct MultiError(Vec<RedsyncError>);

impl MultiError {
    pub fn new() -> Self {
        Default::default()
    }

    pub fn includes(&self, e: RedsyncError) -> bool {
        self.contains(&e)
    }

    pub(crate) fn reset(&mut self) {
        self.clear()
    }
}

impl Deref for MultiError {
    type Target = Vec<RedsyncError>;

    fn deref(&self) -> &Self::Target {
        &self.0
    }
}

impl DerefMut for MultiError {
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut self.0
    }
}

impl fmt::Display for MultiError {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "{} errors occurred:", self.len())?;
        for error in self.iter() {
            write!(f, "\n\t * {}", error)?;
        }

        Ok(())
    }
}