cdrs 2.2.0

Cassandra DB driver written in Rust
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
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

#[cfg(feature = "ssl")]
use openssl::ssl::SslConnector;
use std::time::Duration;

use crate::authenticators::Authenticator;

/// Cluster configuration that holds per node SSL configs
pub struct ClusterSslConfig<'a, A: Authenticator + Sized>(pub Vec<NodeSslConfig<'a, A>>);

/// Single node SSL connection config.
#[derive(Clone)]
pub struct NodeSslConfig<'a, A> {
  pub addr: &'a str,
  pub authenticator: A,
  pub ssl_connector: SslConnector,
  pub max_size: u32,
  pub min_idle: Option<u32>,
  pub max_lifetime: Option<Duration>,
  pub idle_timeout: Option<Duration>,
  pub connection_timeout: Duration,
}

/// Builder structure that helps to configure SSL connection for node.
pub struct NodeSslConfigBuilder<'a, A> {
  addr: &'a str,
  authenticator: A,
  ssl_connector: SslConnector,
  max_size: Option<u32>,
  min_idle: Option<u32>,
  max_lifetime: Option<Duration>,
  idle_timeout: Option<Duration>,
  connection_timeout: Option<Duration>,
}

impl<'a, A: Authenticator + Sized> NodeSslConfigBuilder<'a, A> {
  const DEFAULT_MAX_SIZE: u32 = 10;
  const DEFAULT_CONNECTION_TIMEOUT: Duration = Duration::from_secs(30);

  /// `NodeSslConfigBuilder` constructor function. It receives
  /// * node socket address as a string
  /// * authenticator
  /// * SSL connector structure (for more details see [openssl docs](https://docs.rs/openssl/0.10.12/openssl/ssl/struct.SslConnector.html))
  pub fn new<'b>(
    addr: &'b str,
    authenticator: A,
    ssl_connector: SslConnector,
  ) -> NodeSslConfigBuilder<'b, A> {
    NodeSslConfigBuilder {
      addr,
      authenticator,
      ssl_connector,
      max_size: None,
      min_idle: None,
      max_lifetime: None,
      idle_timeout: None,
      connection_timeout: None,
    }
  }

  /// Sets the maximum number of connections managed by the pool.
  /// Defaults to 10.
  pub fn max_size(mut self, size: u32) -> Self {
    self.max_size = Some(size);
    self
  }

  /// Sets the minimum idle connection count maintained by the pool.
  /// If set, the pool will try to maintain at least this many idle
  /// connections at all times, while respecting the value of `max_size`.
  /// Defaults to None (equivalent to the value of `max_size`).
  pub fn min_idle(mut self, min_idle: Option<u32>) -> Self {
    self.max_size = min_idle;
    self
  }

  /// Sets the maximum lifetime of connections in the pool.
  /// If set, connections will be closed after existing for at most 30 seconds beyond this duration.
  /// If a connection reaches its maximum lifetime while checked out it will be closed when it is returned to the pool.
  /// Defaults to 30 minutes.
  pub fn max_lifetime(mut self, max_lifetime: Option<Duration>) -> Self {
    self.max_lifetime = max_lifetime;
    self
  }

  /// Sets the idle timeout used by the pool.
  /// If set, connections will be closed after sitting idle for at most 30 seconds beyond this duration.
  /// Defaults to 10 minutes.
  pub fn idle_timeout(mut self, idle_timeout: Option<Duration>) -> Self {
    self.idle_timeout = idle_timeout;
    self
  }

  /// Sets the connection timeout used by the pool.
  /// Defaults to 30 seconds.
  pub fn connection_timeout(mut self, connection_timeout: Duration) -> Self {
    self.connection_timeout = Some(connection_timeout);
    self
  }

  /// Sets new authenticator.
  pub fn authenticator(mut self, authenticator: A) -> Self {
    self.authenticator = authenticator;
    self
  }

  /// Finalizes building process and returns `NodeSslConfig`
  pub fn build(self) -> NodeSslConfig<'a, A> {
    NodeSslConfig {
      addr: self.addr,
      authenticator: self.authenticator,
      ssl_connector: self.ssl_connector,

      max_size: self.max_size.unwrap_or(Self::DEFAULT_MAX_SIZE),
      min_idle: self.min_idle,
      max_lifetime: self.max_lifetime,
      idle_timeout: self.idle_timeout,
      connection_timeout: self
        .connection_timeout
        .unwrap_or(Self::DEFAULT_CONNECTION_TIMEOUT),
    }
  }
}