mlb-api 1.0.5

Endpoints for MLB's public Statcast 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

//! Lists all players in the [sport](SportId) in a given season.

use crate::person::{PeopleResponse, PersonHydrations};
use crate::season::SeasonId;
use crate::request::RequestURL;
use crate::hydrations::Hydrations;
use crate::sport::SportId;
use bon::Builder;
use std::fmt::{Display, Formatter};

/// Returns a [`PeopleResponse`].
#[allow(unused, reason = "end user's choice")]
#[derive(Builder)]
#[builder(derive(Into))]
pub struct PlayersRequest<H: PersonHydrations> {
	#[builder(into)]
	#[builder(default)]
	sport_id: SportId,
	#[builder(into)]
	season: Option<SeasonId>,
	#[builder(into)]
	hydrations: <H as Hydrations>::RequestData,
}

impl<H: PersonHydrations, S: players_request_builder::State + players_request_builder::IsComplete> crate::request::RequestURLBuilderExt for PlayersRequestBuilder<H, S> {
	type Built = PlayersRequest<H>;
}

impl PlayersRequest<()> {
	pub fn for_sport(sport_id: impl Into<SportId>) -> PlayersRequestBuilder<(), players_request_builder::SetHydrations<players_request_builder::SetSportId>> {
		Self::builder().sport_id(sport_id).hydrations(())
	}
}

impl<H: PersonHydrations> Display for PlayersRequest<H> {
	fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
		write!(f, "http://statsapi.mlb.com/api/v1/sports/{}/players{}", self.sport_id, gen_params! { "sportId": self.sport_id, "season"?: self.season })
	}
}

impl<H: PersonHydrations> RequestURL for PlayersRequest<H> {
	type Response = PeopleResponse<H>;
}

#[cfg(test)]
mod tests {
	use super::*;
	use crate::TEST_YEAR;
	use crate::request::RequestURLBuilderExt;

	#[tokio::test]
	#[cfg_attr(not(feature = "_heavy_tests"), ignore)]
	async fn parse_all_players_all_seasons_mlb() {
		for season in 1876..=TEST_YEAR {
			let _response = PlayersRequest::for_sport(SportId::MLB).season(season).build_and_get().await.unwrap();
		}
	}

	#[tokio::test]
	async fn parse_all_players_mlb() {
		let _response = PlayersRequest::for_sport(SportId::MLB).build_and_get().await.unwrap();
	}
}