mcsr-ranked-api 0.5.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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132

use std::{num::NonZero, ops::Not};

use serde::Serialize;

#[cfg(feature = "blocking")]
use crate::helpers::make_request_blocking;
use crate::{helpers::make_request, types::Season, Result};

use super::BestTimeLeaderboard;

const BASE_URL: &str = "https://api.mcsrranked.com/record-leaderboard";

/// Season(s) parameter to fetch best times
///
/// - `All`: best times of all time
/// - `Current`: best times of the current season
/// - `Specific(season)`: best times of a specific `season`
///
/// Note: for better ergonomics, its recommended to construct
/// this enum using `From<Season>` or `From<Option<Season>>`
/// to avoid unwrapping `NonZero`
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum BestTimeSeason {
	All,
	Current,
	Specific(NonZero<Season>),
}
impl BestTimeSeason {
	fn is_all(&self) -> bool {
		matches!(self, BestTimeSeason::All)
	}
}
impl Serialize for BestTimeSeason {
	fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
	where
		S: serde::Serializer,
	{
		use BestTimeSeason as BTS;

		serde::Serialize::serialize(
			&match self {
				BTS::All => None,
				BTS::Current => Some(0),
				BTS::Specific(season) => Some(season.get()),
			},
			serializer,
		)
	}
}
impl From<Season> for BestTimeSeason {
	fn from(value: Season) -> Self {
		use BestTimeSeason as BTS;

		match NonZero::new(value) {
			None => BTS::Current,
			Some(v) => BTS::Specific(v),
		}
	}
}
impl From<Option<Season>> for BestTimeSeason {
	fn from(value: Option<Season>) -> Self {
		use BestTimeSeason as BTS;

		match value {
			None => BTS::All,
			Some(season) => Self::from(season),
		}
	}
}

/// Parameters for [`super::BestTimeLeaderboard::get`]
///
/// Note: this struct supports the builder pattern
///
/// # Examples
/// ```
/// use mcsr_ranked_api::leaderboard::game::requests::GetBestTimeLeaderboardParams;
/// let params = GetBestTimeLeaderboardParams::default()
///     .season(0)
///     .distinct(true);
/// ```
#[derive(Debug, Clone, PartialEq, Eq, Serialize)]
pub struct GetBestTimeLeaderboardParams {
	/// Which season to get best times from
	#[serde(skip_serializing_if = "BestTimeSeason::is_all")]
	pub season: BestTimeSeason,
	/// Only fetch distinct players' records
	#[serde(skip_serializing_if = "Not::not")]
	pub distinct: bool,
}
impl Default for GetBestTimeLeaderboardParams {
	fn default() -> Self {
		Self {
			season: BestTimeSeason::All,
			distinct: false,
		}
	}
}
impl GetBestTimeLeaderboardParams {
	/// Construct new params from `season` and `distinct`
	pub fn new(season: impl Into<BestTimeSeason>, distinct: bool) -> Self {
		Self {
			season: season.into(),
			distinct,
		}
	}
	/// Set the `season` field
	pub fn season(mut self, season: impl Into<BestTimeSeason>) -> Self {
		self.season = season.into();
		self
	}
	/// Set the `distinct` field
	pub fn distinct(mut self, distinct: bool) -> Self {
		self.distinct = distinct;
		self
	}
}

impl BestTimeLeaderboard {
	/// GET the best time leaderboard using given `params`
	pub async fn get(params: Option<&GetBestTimeLeaderboardParams>) -> Result<Self> {
		make_request(BASE_URL, &[] as &[&str], params).await
	}
}

#[cfg(feature = "blocking")]
impl BestTimeLeaderboard {
	/// Synchronously GET the best time leaderboard using given `params`
	pub fn get_blocking(params: Option<&GetBestTimeLeaderboardParams>) -> Result<Self> {
		make_request_blocking(BASE_URL, &[] as &[&str], params)
	}
}