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

//! # EVE ESI Alliance Scopes
//!
//! This module provides a type-safe way to add alliance-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                                                           |
//! | -------------------------------------------- | --------------------------------------------------------------------- |
//! | [`AlliancesScopes::new`]                     | Creates a new instance of [`AlliancesScopes`]                         |
//! | [`AlliancesScopes::all`]                     | Creates a new instance of [`AlliancesScopes`] with all scopes applied |
//! | [`AlliancesScopes::read_contacts`]           | Read access to alliance contact information                           |

/// Read access to alliance contact information
pub const READ_CONTACTS: &str = "esi-alliances.read_contacts.v1";

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

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

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

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

    /// Read access to alliance contact information
    ///
    /// Adds the `esi-alliances.read_contacts.v1` scope
    pub fn read_contacts(mut self) -> Self {
        self.scopes.push(READ_CONTACTS.to_string());
        self
    }
}

#[cfg(test)]
mod alliances_scopes_tests {
    use crate::scope::AlliancesScopes;

    /// Tests initializing a default instance of [`AlliancesScopes`]
    #[test]
    fn test_alliances_scopes_default() {
        let alliances_scopes = AlliancesScopes::default();

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