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
74
75
76
77
78
79
80
81
82
83
84
85

//! # EVE ESI Location Scopes
//!
//! This module provides a type-safe way to add location-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                                                          |
//! | ----------------------------------------- | -------------------------------------------------------------------- |
//! | [`LocationScopes::new`]                   | Creates a new instance of [`LocationScopes`]                         |
//! | [`LocationScopes::all`]                   | Creates a new instance of [`LocationScopes`] with all scopes applied |
//! | [`LocationScopes::read_location`]         | Read access to character's current location                          |
//! | [`LocationScopes::read_online`]           | Read access to characer's online status                              |
//! | [`LocationScopes::read_ship_type`]        | Read access to character's ship type                                 |

/// Read access to character's current location
pub const READ_LOCATION: &str = "esi-location.read_location.v1";
/// Read access to characer's online status
pub const READ_ONLINE: &str = "esi-location.read_online.v1";
/// Read access to character's ship type
pub const READ_SHIP_TYPE: &str = "esi-location.read_ship_type.v1";

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

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

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

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

    /// Read access to character's current location
    ///
    /// Adds the `esi-location.read_location.v1` scope
    pub fn read_location(mut self) -> Self {
        self.scopes.push(READ_LOCATION.to_string());
        self
    }

    /// Read access to characer's online status
    ///
    /// Adds the `esi-location.read_online.v1` scope
    pub fn read_online(mut self) -> Self {
        self.scopes.push(READ_ONLINE.to_string());
        self
    }

    /// Read access to character's ship type
    ///
    /// Adds the `esi-location.read_ship_type.v1` scope
    pub fn read_ship_type(mut self) -> Self {
        self.scopes.push(READ_SHIP_TYPE.to_string());
        self
    }
}

#[cfg(test)]
mod location_scopes_tests {
    use crate::scope::LocationScopes;

    /// Tests initializing a default instance of [`LocationScopes`]
    #[test]
    fn test_location_scopes_default() {
        let location_scopes = LocationScopes::default();

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