mcsr-ranked-api 0.3.0

MCSR Ranked API wrapper in Rust
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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104

use chrono::{serde::ts_seconds, DateTime, Utc};
use serde::Deserialize;

#[cfg(feature = "weekly_races")]
use crate::types::WeeklyRaceId;
use crate::{
	helpers::string_u64,
	types::{MinecraftSeed, Rank, Time},
	user::UserProfile,
};

pub mod requests;
pub mod result;
#[cfg(test)]
pub mod tests;

/// Seeds for overworld, nether, end and RNG
#[derive(Debug, Clone, PartialEq, Eq, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct WeeklyRaceSeedInfo {
	#[serde(deserialize_with = "string_u64")]
	overworld: MinecraftSeed,
	#[serde(deserialize_with = "string_u64")]
	nether: MinecraftSeed,
	#[serde(deserialize_with = "string_u64")]
	the_end: MinecraftSeed,
	#[serde(deserialize_with = "string_u64")]
	rng: MinecraftSeed,
}
impl WeeklyRaceSeedInfo {
	/// Overworld dimension seed
	pub fn overworld(&self) -> MinecraftSeed {
		self.overworld
	}
	/// Nether dimension seed
	pub fn nether(&self) -> MinecraftSeed {
		self.nether
	}
	/// The end dimension seed
	pub fn end(&self) -> MinecraftSeed {
		self.the_end
	}
	/// RNG seed
	pub fn rng(&self) -> MinecraftSeed {
		self.rng
	}
}

/// Seeds for overworld, nether, end and RNG
#[derive(Debug, Clone, PartialEq, Eq, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct WeeklyRaceLeaderboardRecord {
	rank: Rank,
	player: UserProfile,
	time: Time,
	replay_exist: bool,
}
impl WeeklyRaceLeaderboardRecord {
	/// Entry's rank, 1-indexed
	pub fn rank(&self) -> Rank {
		self.rank
	}
	/// The user owning the entry
	pub fn player(&self) -> &UserProfile {
		&self.player
	}
	/// The final time
	pub fn time(&self) -> Time {
		self.time
	}
	/// Does the replay exist
	pub fn replay_exists(&self) -> bool {
		self.replay_exist
	}
}

/// Weekly race info
#[derive(Debug, Clone, PartialEq, Eq, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct WeeklyRaceLeaderboardInfo {
	id: WeeklyRaceId,
	seed: WeeklyRaceSeedInfo,
	#[serde(with = "ts_seconds")]
	ends_at: DateTime<Utc>,
	leaderboard: Box<[WeeklyRaceLeaderboardRecord]>,
}
impl WeeklyRaceLeaderboardInfo {
	/// Id of the race, 1-indexed
	pub fn id(&self) -> &WeeklyRaceId {
		&self.id
	}
	/// The seeds for different dimensions and RNG
	pub fn seeds(&self) -> &WeeklyRaceSeedInfo {
		&self.seed
	}
	/// The end date and time
	pub fn ends_at(&self) -> &DateTime<Utc> {
		&self.ends_at
	}
	/// The leaderboard for the race
	pub fn leaderboard(&self) -> &[WeeklyRaceLeaderboardRecord] {
		&self.leaderboard
	}
}