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

//! # EVE ESI Search Scopes
//!
//! This module provides a type-safe way to add search-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                                                        |
//! | ----------------------------------------- | ------------------------------------------------------------------ |
//! | [`SearchScopes::new`]                     | Creates a new instance of [`SearchScopes`]                         |
//! | [`SearchScopes::all`]                     | Creates a new instance of [`SearchScopes`] with all scopes applied |
//! | [`SearchScopes::search_structures`]       | Access to search for structures character has access to            |

/// Access to search for structures character has access to
pub const SEARCH_STRUCTURES: &str = "esi-search.search_structures.v1";

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

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

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

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

    /// Access to search for structures character has access to
    ///
    /// Adds the `esi-search.search_structures.v1` scope
    pub fn search_structures(mut self) -> Self {
        self.scopes.push(SEARCH_STRUCTURES.to_string());
        self
    }
}

#[cfg(test)]
mod search_scopes_tests {
    use crate::scope::SearchScopes;

    /// Tests initializing a default instance of [`SearchScopes`]
    #[test]
    fn test_search_scopes_default() {
        let search_scopes = SearchScopes::default();

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