earthmc 2.0.1

Async client for interacting with the EarthMC API
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
86

use serde::{Deserialize, Serialize};
use uuid::Uuid;

use crate::{
    endpoints::{nations::NationRankKind, towns::TownRankKind},
    model::{
        named_uuid::{NamedUuid, NamedUuidOpt},
        permission::TownyPermissions,
        timestamp::Timestamp,
    },
};

#[derive(Clone, Deserialize, Serialize, PartialEq, Debug)]
#[serde(rename_all = "camelCase")]
pub struct Player {
    pub name: String,
    pub uuid: Uuid,
    /// Set through `/n set title` in-game.
    pub title: Option<String>,
    /// Set through `/n set surname` in-game.
    pub surname: Option<String>,
    /// Formatted name combining, in this order, title, username and surname.
    pub formatted_name: String,
    /// About section of `/res` set with `/res set about` in-game.
    pub about: Option<String>,
    pub town: NamedUuidOpt,
    pub nation: NamedUuidOpt,
    pub timestamps: PlayerTimestamps,
    pub status: PlayerStatus,
    pub stats: PlayerStats,
    pub perms: TownyPermissions,
    pub ranks: PlayerRanks,
    pub friends: Vec<NamedUuid>,
}

#[derive(Clone, Deserialize, Serialize, PartialEq, Debug)]
#[serde(rename_all = "camelCase")]
pub struct PlayerTimestamps {
    /// Server join time.
    #[cfg_attr(
        feature = "chrono",
        serde(with = "crate::model::timestamp::seconds")
    )]
    pub registered: Timestamp,
    /// Town join time.
    #[cfg_attr(
        feature = "chrono",
        serde(with = "crate::model::timestamp::optional_seconds")
    )]
    pub joined_town_at: Option<Timestamp>,
    /// Last online time.
    /// Can be [`None`] if the player is an NPC.
    #[cfg_attr(
        feature = "chrono",
        serde(with = "crate::model::timestamp::optional_seconds")
    )]
    pub last_online: Option<Timestamp>,
}

#[derive(Clone, Deserialize, Serialize, PartialEq, Debug)]
#[serde(rename_all = "camelCase")]
pub struct PlayerStatus {
    pub is_online: bool,
    /// Towny NPC flag.
    #[serde(rename = "isNPC")]
    pub is_npc: bool,
    pub is_mayor: bool,
    pub is_king: bool,
    pub has_town: bool,
    pub has_nation: bool,
}

#[derive(Clone, Deserialize, Serialize, PartialEq, Debug)]
#[serde(rename_all = "camelCase")]
pub struct PlayerStats {
    /// Shown on `/res` in-game.
    pub balance: f64,
    pub num_friends: i32,
}

#[derive(Clone, Deserialize, Serialize, PartialEq, Debug)]
#[serde(rename_all = "camelCase")]
pub struct PlayerRanks {
    pub town_ranks: Vec<TownRankKind>,
    pub nation_ranks: Vec<NationRankKind>,
}