cocklock 0.1.0

Implementation of the distributed locking mechanism built on top of Postgres/CockroachDB
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

use postgres::{Client, NoTls};
use postgres_native_tls::MakeTlsConnector;
use uuid::Uuid;

use crate::errors::CockLockError;
use crate::lock::{CockLock, CockLockQueries, DEFAULT_TABLE};

pub struct CockLockBuilder {
    /// List of all Postgres/Cockroach clients
    clients: Vec<Client>,
    client_connection_strings: Vec<String>,
    tls_connector: Option<MakeTlsConnector>,
    table_name: String,
}

impl Default for CockLockBuilder {
    fn default() -> Self {
        Self {
            clients: vec![],
            client_connection_strings: vec![],
            tls_connector: None,
            table_name: DEFAULT_TABLE.to_owned(),
        }
    }
}

/// A builder for the CockLock struct
///
/// Allows chaining of methods to build a new CockLock using either Postgres
/// or Cockroach connections.
impl CockLockBuilder {
    /// Instantiate a new CockLock builder
    pub fn new() -> Self {
        Self::default()
    }

    /// Add some client connection strings
    pub fn with_connection_strings<T: ToString>(mut self, connection_strings: Vec<T>) -> Self {
        for connection_string in connection_strings {
            self.client_connection_strings
                .push(connection_string.to_string());
        }
        self
    }

    /// Change the table name to be used for locks
    pub fn with_table_name<T: ToString>(mut self, table_name: T) -> Self {
        self.table_name = table_name.to_string();
        self
    }

    /// Add custom clients
    ///
    /// Clients may be made from the postgres package and added here
    pub fn with_clients(mut self, clients: &mut Vec<Client>) -> Self {
        self.clients.append(clients);
        self
    }

    /// Build a CockLock instance using the builder
    pub fn build(self) -> Result<CockLock, CockLockError> {
        let mut clients = self.clients;
        for connection_string in self.client_connection_strings {
            match &self.tls_connector {
                Some(connector) => {
                    clients.push(Client::connect(&connection_string, connector.clone())?);
                }
                None => {
                    clients.push(Client::connect(&connection_string, NoTls)?);
                }
            }
        }

        if clients.is_empty() {
            return Err(CockLockError::NoClients);
        }

        let instance = CockLock::new(CockLock {
            id: Uuid::new_v4(),
            clients,
            table_name: self.table_name,
            queries: CockLockQueries::default(),
        })?;

        Ok(instance)
    }
}