eve_esi 0.4.9

Thread-safe, asynchronous client for EVE Online's ESI & OAuth2
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

//! # EVE ESI Mail Scopes
//!
//! This module provides a type-safe way to add mail-related scopes for OAuth2 to the [`super::ScopeBuilder`]
//!
//! See [module-level documentation](super) for an overview & usage of scopes for the esi_crate
//!
//! ## Methods
//! | Method                                    | Description                                                      |
//! | ----------------------------------------- | ---------------------------------------------------------------- |
//! | [`MailScopes::new`]                       | Creates a new instance of [`MailScopes`]                         |
//! | [`MailScopes::all`]                       | Creates a new instance of [`MailScopes`] with all scopes applied |
//! | [`MailScopes::organize_mail`]             | Access to organize character's mail                              |
//! | [`MailScopes::read_mail`]                 | Read access to character's eve mails                             |
//! | [`MailScopes::send_mail`]                 | Write access to send eve mails on behalf of character            |

/// Access to organize character's mail
pub const ORGANIZE_MAIL: &str = "esi-mail.organize_mail.v1";
/// Read access to character's eve mails
pub const READ_MAIL: &str = "esi-mail.read_mail.v1";
/// Write access to send eve mails on behalf of character
pub const SEND_MAIL: &str = "esi-mail.send_mail.v1";

/// Struct with methods for listing mail scopes to request for OAuth2
pub struct MailScopes {
    pub(super) scopes: Vec<String>,
}

impl Default for MailScopes {
    /// Create a default instance of [`MailScopes`]
    fn default() -> Self {
        Self::new()
    }
}

impl MailScopes {
    /// Create a new instance of [`MailScopes`]
    pub fn new() -> Self {
        MailScopes { scopes: Vec::new() }
    }

    /// Creates a new instance of [`MailScopes`] with all scopes applied
    pub fn all() -> Self {
        MailScopes::new().organize_mail().read_mail().send_mail()
    }

    /// Access to organize character's mail
    ///
    /// Adds the `esi-mail.organize_mail.v1` scope
    pub fn organize_mail(mut self) -> Self {
        self.scopes.push(ORGANIZE_MAIL.to_string());
        self
    }

    /// Read access to character's eve mails
    ///
    /// Adds the `esi-mail.read_mail.v1` scope
    pub fn read_mail(mut self) -> Self {
        self.scopes.push(READ_MAIL.to_string());
        self
    }

    /// Write access to send eve mails on behalf of character
    ///
    /// Adds the `esi-mail.send_mail.v1` scope
    pub fn send_mail(mut self) -> Self {
        self.scopes.push(SEND_MAIL.to_string());
        self
    }
}

#[cfg(test)]
mod mail_scopes_tests {
    use crate::scope::MailScopes;

    /// Tests initializing a default instance of [`MailScopes`]
    #[test]
    fn test_mail_scopes_default() {
        let mail_scopes = MailScopes::default();

        assert_eq!(mail_scopes.scopes.len(), 0)
    }
}