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

use serde::Serialize;

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

use super::{
	identifier::UserIdentifier,
	info::{all_seasons::AllSeasonUserInfo, UserInfo},
};

const BASE_URL: &str = "https://api.mcsrranked.com/users/{}";
const ALL_SEASONS_URL: &str = "https://api.mcsrranked.com/users/{}/seasons";

/// Parameters for [`UserIdentifier::get_user`]
#[derive(Debug, Clone, PartialEq, Eq, Default, Serialize)]
#[serde(rename_all = "lowercase")]
pub struct GetUserParams {
	/// Season to get the user info for
	///
	/// Default is the current season
	pub season: Option<Season>,
}
impl GetUserParams {
	pub fn new(season: Season) -> Self {
		Self {
			season: Some(season),
		}
	}
}

impl UserIdentifier<'_> {
	/// GET the user by identifier using given `params`
	pub async fn get_user(&self, params: Option<&GetUserParams>) -> Result<UserInfo> {
		make_request(BASE_URL, [&self.to_string()], Some(&params)).await
	}
	/// GET the user's info with data from all seasons
	pub async fn get_user_all_seasons(&self) -> Result<AllSeasonUserInfo> {
		make_request(ALL_SEASONS_URL, &[&self.to_string()], None::<&()>).await
	}
}

#[cfg(feature = "blocking")]
impl UserIdentifier<'_> {
	/// Synchronously GET the user by identifier using given `params`
	pub fn get_user_blocking(&self, params: Option<&GetUserParams>) -> Result<UserInfo> {
		make_request_blocking(BASE_URL, [&self.to_string()], Some(&params))
	}
	/// Synchronously GET the user's info with data from all seasons
	pub fn get_user_all_seasons_blocking(&self) -> Result<AllSeasonUserInfo> {
		make_request_blocking(ALL_SEASONS_URL, &[&self.to_string()], None::<&()>)
	}
}