screeps-api 0.6.0

Fully typed and tested wrapper over the Screeps Game's HTTP API
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

//! Endpoints relating to game leaderboards.
pub mod find_rank;
pub mod page;
pub mod season_list;

pub use self::{find_rank::*, page::*, season_list::*};

/// Type of leaderboards that are available for each season.
#[derive(Copy, Clone, Eq, PartialEq, Hash, Debug)]
pub enum LeaderboardType {
    /// Global control point leaderboard.
    GlobalControl,
    /// Power processed leaderboard
    PowerProcessed,
    /// A marker variant that tells the compiler that users of this enum cannot match it exhaustively.
    #[doc(hidden)]
    __Nonexhaustive,
}

impl LeaderboardType {
    /// Gets the representation of this leaderbaord type in the raw API calls.
    ///
    /// Mostly for internal use, but if you can find a reason to call this, feel free.
    pub fn api_representation(&self) -> &'static str {
        match *self {
            LeaderboardType::GlobalControl | LeaderboardType::__Nonexhaustive => "world",
            LeaderboardType::PowerProcessed => "power",
        }
    }
}