mcsr-ranked-api 0.5.2

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

use serde::Serialize;

#[cfg(feature = "matches")]
use crate::game::{requests::GetMatchesParams, MatchInfo};
#[cfg(feature = "blocking")]
use crate::helpers::make_request_blocking;
use crate::{helpers::make_request, types::Season, user::identifier::UserIdentifier, Result};

use super::VersusInfo;

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

/// Parameters for [`VersusInfo::get`]
#[derive(Debug, Clone, PartialEq, Eq, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct GetVersusInfoParams {
	pub season: Option<Season>,
}
impl GetVersusInfoParams {
	pub fn season(season: Season) -> Self {
		Self {
			season: Some(season),
		}
	}
}

impl VersusInfo {
	/// GET versus info between two players using `params`
	pub async fn get<'a>(
		user_1: &UserIdentifier<'a>,
		user_2: &UserIdentifier<'a>,
		params: Option<&GetVersusInfoParams>,
	) -> Result<Self> {
		make_request(BASE_URL, [&user_1.to_string(), &user_2.to_string()], params).await
	}
	#[cfg(feature = "matches")]
	/// GET versus matches between two players using `params`
	pub async fn get_matches<'a>(
		user_1: &UserIdentifier<'a>,
		user_2: &UserIdentifier<'a>,
		params: Option<&GetMatchesParams>,
	) -> Result<Vec<MatchInfo>> {
		make_request(
			MATCHES_URL,
			[&user_1.to_string(), &user_2.to_string()],
			params,
		)
		.await
	}
}

#[cfg(feature = "blocking")]
impl VersusInfo {
	/// Synchronously GET versus info between two players using `params`
	pub fn get_blocking<'a>(
		user_1: &UserIdentifier<'a>,
		user_2: &UserIdentifier<'a>,
		params: Option<&GetVersusInfoParams>,
	) -> Result<Self> {
		make_request_blocking(BASE_URL, [&user_1.to_string(), &user_2.to_string()], params)
	}
	#[cfg(feature = "matches")]
	/// Synchronounsly GET versus matches between two players using `params`
	pub fn get_matches_blocking<'a>(
		user_1: &UserIdentifier<'a>,
		user_2: &UserIdentifier<'a>,
		params: Option<&GetMatchesParams>,
	) -> Result<Vec<MatchInfo>> {
		make_request_blocking(
			MATCHES_URL,
			[&user_1.to_string(), &user_2.to_string()],
			params,
		)
	}
}