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

//! # EVE ESI Contracts Scopes
//!
//! This module provides a type-safe way to add contract-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                                                           |
//! | ----------------------------------------------- | --------------------------------------------------------------------- |
//! | [`ContractsScopes::new`]                        | Creates a new instance of [`ContractsScopes`]                         |
//! | [`ContractsScopes::all`]                        | Creates a new instance of [`ContractsScopes`] with all scopes applied |
//! | [`ContractsScopes::read_character_contracts`]   | Read access to character contracts                                    |
//! | [`ContractsScopes::read_corporation_contracts`] | Read access to corporation contracts                                  |

/// Read access to character contracts
pub const READ_CHARACTER_CONTRACTS: &str = "esi-contracts.read_character_contracts.v1";
/// Read access to corporation contracts
pub const READ_CORPORATION_CONTRACTS: &str = "esi-contracts.read_corporation_contracts.v1";

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

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

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

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

    /// Read access to character contracts
    ///
    /// Adds the `esi-contracts.read_character_contracts.v1` scope
    pub fn read_character_contracts(mut self) -> Self {
        self.scopes.push(READ_CHARACTER_CONTRACTS.to_string());
        self
    }

    /// Read access to corporation contracts
    ///
    /// Adds the `esi-contracts.read_corporation_contracts.v1` scope
    pub fn read_corporation_contracts(mut self) -> Self {
        self.scopes.push(READ_CORPORATION_CONTRACTS.to_string());
        self
    }
}

#[cfg(test)]
mod contracts_scopes_tests {
    use crate::scope::ContractsScopes;

    /// Tests initializing a default instance of [`ContractsScopes`]
    #[test]
    fn test_contracts_scopes_default() {
        let contracts_scopes = ContractsScopes::default();

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