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 Fleets Scopes
//!
//! This module provides a type-safe way to add fleet-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                                                        |
//! | ----------------------------------------- | ------------------------------------------------------------------ |
//! | [`FleetsScopes::new`]                     | Creates a new instance of [`FleetsScopes`]                         |
//! | [`FleetsScopes::all`]                     | Creates a new instance of [`FleetsScopes`] with all scopes applied |
//! | [`FleetsScopes::read_fleet`]              | Read access to character fleet information                         |
//! | [`FleetsScopes::write_fleet`]             | Write access to fleet if character holds sufficient fleet roles    |

/// Read access to character fleet information
pub const READ_FLEET: &str = "esi-fleets.read_fleet.v1";
/// Write access to fleet if character holds sufficient fleet roles
pub const WRITE_FLEET: &str = "esi-fleets.write_fleet.v1";

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

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

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

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

    /// Read access to character fleet information
    ///
    /// Adds the `esi-fittings.read_fittings.v1` scope
    pub fn read_fleet(mut self) -> Self {
        self.scopes.push(READ_FLEET.to_string());
        self
    }

    /// Write access to fleet if character holds sufficient fleet roles
    ///
    /// Adds the `esi-fittings.write_fittings.v1` scope
    pub fn write_fleet(mut self) -> Self {
        self.scopes.push(WRITE_FLEET.to_string());
        self
    }
}

#[cfg(test)]
mod fleets_scopes_tests {
    use crate::scope::FleetsScopes;

    /// Tests initializing a default instance of [`FleetsScopes`]
    #[test]
    fn test_fleets_scopes_default() {
        let fleets_scopes = FleetsScopes::default();

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