arangors 0.6.0

Rust driver for ArangoDB
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

//! Type definitions for various authentication methods.

/// According to aragndb document, supported auth methods are
/// - basicAuth
/// - JWT
/// - no auth
///
/// And this enum provides an abstraction to these methods.
///
/// Auth is then used when initialize `Connection`.
///
/// # Example
/// ```rust, ignore
/// use arangors::connection::Auth;
///
/// let basic_auth = Auth::basic("username", "password");
/// let jwt_auth = Auth::jwt("username", "password");
/// let no_auth = Auth::None;
/// let no_auth = Auth::default();
/// ```
#[derive(Debug, Clone, Default)]
pub(crate) enum Auth<'a> {
    /// Basic auth
    Basic(Credential<'a>),
    /// JSON Web Token (JWT) auth
    Jwt(Credential<'a>),
    /// no auth
    #[default]
    None,
}

impl<'a> Auth<'a> {
    pub fn basic(username: &'a str, password: &'a str) -> Auth<'a> {
        Auth::Basic(Credential { username, password })
    }

    pub fn jwt(username: &'a str, password: &'a str) -> Auth<'a> {
        Auth::Jwt(Credential { username, password })
    }
}

/// Username and password holder for authentication
#[derive(Debug, Clone, Hash)]
pub(crate) struct Credential<'a> {
    /// username
    pub username: &'a str,
    /// password
    pub password: &'a str,
}