skytable 0.8.12

Official Rust client driver for Skytable
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

/*
 * Copyright 2023, Sayan Nandan <nandansayan@outlook.com>
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
*/

//! # Configuration
//!
//! This module provides items to help with database connection setup and configuration.
//!
//! ## Example
//!
//! ```no_run
//! use skytable::Config;
//!
//! // establish a sync connection to 127.0.0.1:2003
//! let mut db = Config::new_default("username", "password").connect().unwrap();
//!
//! // establish a connection to a specific host `subnetx2_db1` and port `2008`
//! let mut db = Config::new("subnetx2_db1", 2008, "username", "password").connect().unwrap();
//! ```

use crate::protocol::handshake::ProtocolVersion;

/// The default host
///
/// NOTE: If you are using a clustering setup, don't use this!
pub const DEFAULT_HOST: &str = "127.0.0.1";
/// The default TCP port (skyhash/tcp)
pub const DEFAULT_TCP_PORT: u16 = 2003;
/// The default TLS port (skyhash/tls)
pub const DEFAULT_TLS_PORT: u16 = 2002;

#[derive(Debug, Clone, PartialEq)]
/// Configuration for a Skytable connection
pub struct Config {
    host: Box<str>,
    port: u16,
    username: Box<str>,
    password: Box<str>,
    pub(crate) protocol: ProtocolVersion,
}

impl Config {
    fn _new(
        host: Box<str>,
        port: u16,
        username: Box<str>,
        password: Box<str>,
        protocol: ProtocolVersion,
    ) -> Self {
        Self {
            host,
            port,
            username,
            password,
            protocol,
        }
    }
    /// Create a new [`Config`] using the default connection settings and using the provided username and password
    pub fn new_default(username: &str, password: &str) -> Self {
        Self::new(DEFAULT_HOST, DEFAULT_TCP_PORT, username, password)
    }
    /// Create a new [`Config`] using the given settings.
    ///
    /// **PROTOCOL VERSION**: Defaults to [`ProtocolVersion::V2_0`]
    pub fn new(host: &str, port: u16, username: &str, password: &str) -> Self {
        Self::_new(
            host.into(),
            port,
            username.into(),
            password.into(),
            ProtocolVersion::V2_0,
        )
    }
    /// Returns the host setting for this this configuration
    pub fn host(&self) -> &str {
        self.host.as_ref()
    }
    /// Returns the port setting for this this configuration
    pub fn port(&self) -> u16 {
        self.port
    }
    /// Returns the username setting for this this configuration
    pub fn username(&self) -> &str {
        self.username.as_ref()
    }
    /// Returns the password set using this configuration
    pub fn password(&self) -> &str {
        self.password.as_ref()
    }
}