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 Skills Scopes
//!
//! This module provides a type-safe way to add skill-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                                                        |
//! | ----------------------------------------- | ------------------------------------------------------------------ |
//! | [`SkillsScopes::new`]                     | Creates a new instance of [`SkillsScopes`]                         |
//! | [`SkillsScopes::all`]                     | Creates a new instance of [`SkillsScopes`] with all scopes applied |
//! | [`SkillsScopes::read_skillqueue`]         | Read access to character's skill queue                             |
//! | [`SkillsScopes::read_skills`]             | Read access to character's skills                                  |

/// Read access to character's skill queue
pub const READ_SKILLQUEUE: &str = "esi-skills.read_skillqueue.v1";
/// Read access to character's skills
pub const READ_SKILLS: &str = "esi-skills.read_skills.v1";

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

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

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

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

    /// Read access to character's skill queue
    ///
    /// Adds the `esi-skills.read_skillqueue.v1` scope
    pub fn read_skillqueue(mut self) -> Self {
        self.scopes.push(READ_SKILLQUEUE.to_string());
        self
    }

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

#[cfg(test)]
mod skills_scopes_tests {
    use crate::scope::SkillsScopes;

    /// Tests initializing a default instance of [`SkillsScopes`]
    #[test]
    fn test_skills_scopes_default() {
        let skills_scopes = SkillsScopes::default();

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