rincon_client 0.1.1

A typesafe client for the ArangoDB Rest API
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

//! Types used in methods for user authentication.

use rincon_core::api::auth::Jwt;

/// This structs holds the properties necessary to authenticate a user.
#[derive(Debug, Clone, PartialEq, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct AuthenticationRequest {
    username: String,
    password: String,
}

impl AuthenticationRequest {
    /// Constructs a new instance of an `AuthenticationRequest` containing the
    /// given username and password.
    pub fn new<N, P>(username: N, password: P) -> Self
        where N: Into<String>, P: Into<String>
    {
        AuthenticationRequest {
            username: username.into(),
            password: password.into(),
        }
    }

    /// Returns the username in this `AuthenticationRequest`.
    pub fn username(&self) -> &str {
        &self.username
    }

    /// Returns the password in this `AuthenticationRequest`.
    pub fn password(&self) -> &str {
        &self.password
    }
}

/// This struct holds the result of a successful authentication.
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct AuthenticationResponse {
    jwt: Jwt,
    must_change_password: Option<bool>
}

impl AuthenticationResponse {
    /// Returns the JSON Web Token (JWT).
    pub fn jwt(&self) -> &Jwt {
        &self.jwt
    }

    /// Returns whether the password must be changed.
    pub fn is_must_change_password(&self) -> Option<bool> {
        self.must_change_password
    }
}