halo_api 0.3.0

Unofficial Halo Infinite REST API client for Rust (CSR, service record, match history, and more).
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

//! A player identifier accepted by Halo Infinite endpoints.

use xbox::models::Xuid;

/// A player identifier: either a gamertag or a numeric XUID.
///
/// Construction is explicit ([`Self::gamertag`], [`Self::xuid`], or `From<Xuid>`) rather than via
/// `From<&str>`/`From<String>`. A raw XUID is itself just a numeric string, so a blanket string
/// conversion would let a caller holding a raw XUID string silently produce [`Player::Gamertag`]
/// instead, defeating the point of this type.
///
/// Endpoints that require a numeric XUID resolve a [`Player::Gamertag`] transparently (one extra
/// lookup); endpoints that accept Halo's `gt(...)`/`xuid(...)` forms interchangeably use whichever
/// variant was given directly, with no extra network call.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub enum Player {
    Gamertag(String),
    Xuid(Xuid),
}

impl Player {
    pub fn gamertag(gamertag: impl Into<String>) -> Self {
        Self::Gamertag(gamertag.into())
    }

    pub fn xuid(xuid: impl Into<Xuid>) -> Self {
        Self::Xuid(xuid.into())
    }
}

impl From<Xuid> for Player {
    fn from(xuid: Xuid) -> Self {
        Self::Xuid(xuid)
    }
}

impl From<&Xuid> for Player {
    fn from(xuid: &Xuid) -> Self {
        Self::Xuid(xuid.clone())
    }
}

impl std::fmt::Display for Player {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Self::Gamertag(gamertag) => write!(f, "{gamertag}"),
            Self::Xuid(xuid) => write!(f, "{xuid}"),
        }
    }
}