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

//! # EVE ESI Planets Scopes
//!
//! This module provides a type-safe way to add planet-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                                                         |
//! | ------------------------------------------ | ------------------------------------------------------------------- |
//! | [`PlanetsScopes::new`]                     | Creates a new instance of [`PlanetsScopes`]                         |
//! | [`PlanetsScopes::all`]                     | Creates a new instance of [`PlanetsScopes`] with all scopes applied |
//! | [`PlanetsScopes::manage_planets`]          | Read access to character's planetary interaction                    |
//! | [`PlanetsScopes::read_customs_offices`]    | Read access to corporation-owned customs offices                    |

/// Read access to character's planetary interaction
pub const MANAGE_PLANETS: &str = "esi-planets.manage_planets.v1";
/// Read access to corporation-owned customs offices
pub const READ_CUSTOMS_OFFICES: &str = "esi-planets.read_customs_offices.v1";

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

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

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

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

    /// Read access to character's planetary interaction
    ///
    /// Adds the `esi-planets.manage_planets.v1` scope
    pub fn manage_planets(mut self) -> Self {
        self.scopes.push(MANAGE_PLANETS.to_string());
        self
    }

    /// Read access to corporation-owned customs offices
    ///
    /// Adds the `esi-planets.read_customs_offices.v1` scope
    pub fn read_customs_offices(mut self) -> Self {
        self.scopes.push(READ_CUSTOMS_OFFICES.to_string());
        self
    }
}

#[cfg(test)]
mod planets_scopes_tests {
    use crate::scope::PlanetsScopes;

    /// Tests initializing a default instance of [`PlanetsScopes`]
    #[test]
    fn test_planets_scopes_default() {
        let planets_scopes = PlanetsScopes::default();

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