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 Fittings Scopes
//!
//! This module provides a type-safe way to add fitting-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                                                          |
//! | ------------------------------------------- | -------------------------------------------------------------------- |
//! | [`FittingsScopes::new`]                     | Creates a new instance of [`FittingsScopes`]                         |
//! | [`FittingsScopes::all`]                     | Creates a new instance of [`FittingsScopes`] with all scopes applied |
//! | [`FittingsScopes::read_fittings`]           | Read access to character fittings                                    |
//! | [`FittingsScopes::write_fittings`]          | Write access to character fittings                                   |

/// Read access to character fittings
pub const READ_FITTINGS: &str = "esi-fittings.read_fittings.v1";
/// Write access to character fittings
pub const WRITE_FITTINGS: &str = "esi-fittings.write_fittings.v1";

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

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

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

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

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

    /// Write access to character fittings
    ///
    /// Adds the `esi-fittings.write_fittings.v1` scope
    pub fn write_fittings(mut self) -> Self {
        self.scopes.push(WRITE_FITTINGS.to_string());
        self
    }
}

#[cfg(test)]
mod fittings_scopes_tests {
    use crate::scope::FittingsScopes;

    /// Tests initializing a default instance of [`FittingsScopes`]
    #[test]
    fn test_fittings_scopes_default() {
        let fittings_scopes = FittingsScopes::default();

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