mlb_api/requests/stats/
mod.rs

1//! # The Stats API
2//!
3//! The second most likely reason you're here.
4//!
5//! [`mlb_api`](crate)'s stats system designed to be simple to use.
6//! Create a stats type, then create the hydrations which have stats in it, then request it.
7//!
8//! Almost all the types here are for private use and occasionally might be
9//!
10//! ## Examples
11//! See [`stats_hydrations!`](crate::stats_hydrations) for examples on how to use the macro.
12//!
13//! ## Notes
14//! 1. The stat type registry is admittedly incomplete, only some stat types are implemented (see [`stat_types`]), more will come in the future.
15//! 2. Some stats are only implemented for specific [`StatGroup`](crate::meta::StatGroup)s, if you have a complicated request such as:
16//! ```
17//! stats_hydrations! {
18//!     pub struct TechnicalStats {
19//!         [Sabermetrics, Career] + [Hitting, Pitching, Fielding, Catching]
20//!     }
21//! }
22//! ```
23//! `stats.sabermetrics.fielding` and `.catching` will be of type `()`.
24//! 3. It is an intentional decision that [`SituationCode`](crate::meta::SituationCode)s
25//! are not registered in an enum as if new cutting-edge situation-codes come out,
26//! this API being outdated shouldn't limit in that factor.
27
28use serde::de::DeserializeOwned;
29use serde::Deserialize;
30use std::convert::Infallible;
31use std::fmt::Debug;
32
33#[doc(hidden)]
34pub mod macros;
35#[doc(hidden)]
36pub mod raw;
37#[doc(hidden)]
38pub mod wrappers;
39pub mod leaders;
40#[doc(hidden)]
41mod units;
42#[doc(hidden)]
43pub mod parse;
44pub mod derived;
45
46pub use units::*;
47
48#[cfg(test)]
49mod tests;
50
51// pub use derived::*;
52
53pub trait Stat: Debug + Clone + PartialEq + Default {
54	type Split: DeserializeOwned;
55
56	type TryFromSplitError;
57
58	/// # Errors
59	/// See [`Self::TryFromSplitError`]
60	fn from_splits(splits: impl Iterator<Item=Self::Split>) -> Result<Self, Self::TryFromSplitError> where Self: Sized;
61}
62
63/// Represents the types defined in [`raw`], not the wrapped final types. In the serialized format, this represents the `stat` field.
64pub trait RawStat: Debug + DeserializeOwned + Clone + PartialEq + Default {}
65
66impl RawStat for () {}
67impl SingletonSplitStat for () {}
68
69/// Represents types that are made from a single 'split' in the serialized format (able to be deserialized)
70pub trait SingletonSplitStat: Debug + DeserializeOwned + Clone + PartialEq + Default {
71
72}
73
74impl<T: SingletonSplitStat> Stat for T {
75	type Split = Self;
76
77	type TryFromSplitError = &'static str;
78
79	fn from_splits(mut splits: impl Iterator<Item=Self::Split>) -> Result<Self, Self::TryFromSplitError>
80	where
81		Self: Sized
82	{
83		splits.next().ok_or("length of stat splits is not >= 1, cannot convert to unit type.")
84	}
85}
86
87pub trait StatTypeStats {
88	type Hitting: Stat;
89
90	type Pitching: Stat;
91
92	type Fielding: Stat;
93
94	type Catching: Stat;
95}
96
97#[derive(Debug, Deserialize, PartialEq, Eq, Clone, Default)]
98pub struct PlayStat {
99	// pub play: Play,
100}
101
102// todo: replace with real struct once game stuff is implemented
103pub type PitchStat = ();
104
105impl RawStat for PlayStat {}
106
107impl<T: Stat> Stat for Option<T> {
108	type Split = T::Split;
109	type TryFromSplitError = Infallible;
110
111	fn from_splits(splits: impl Iterator<Item=Self::Split>) -> Result<Self, Self::TryFromSplitError>
112	where
113		Self: Sized
114	{
115		Ok(T::from_splits(splits).ok())
116	}
117}
118
119#[doc(hidden)]
120pub mod stat_types {
121	use super::{StatTypeStats, PlayStat, PitchStat};
122	use crate::stats::raw::{catching, fielding, hitting, pitching, FieldedMatchup};
123	use crate::stats::wrappers::{AccumulatedVsPlayerMatchup, ByMonth, ByPosition, BySeason, ByWeekday, Career, Map, Map2D, SingleMatchup, WithGame, WithHomeAndAway, WithMonth, WithNone, WithPlayer, WithPositionAndSeason, WithSeason, WithTeam, WithWeekday, WithWinLoss};
124
125	macro_rules! stat_type_stats {
126		($name:ident {
127			$hitting:ty,
128			$pitching:ty,
129			$catching:ty,
130			$fielding:ty $(,)?
131		}) => {
132			::pastey::paste! {
133				#[doc(hidden)]
134				pub struct [<__ $name StatTypeStats>];
135
136				impl StatTypeStats for [<__ $name StatTypeStats>] {
137					type Hitting = $hitting;
138					type Pitching = $pitching;
139					type Fielding = $fielding;
140					type Catching = $catching;
141				}
142			}
143		};
144	}
145
146	// NOTES
147	// 1. Make sure all modules are correct, `hitting`, `pitching`, `catching`, then `fielding`.
148
149	stat_type_stats!(Projected { WithPlayer<hitting::__ProjectedStatsData>, WithPlayer<pitching::__ProjectedStatsData>, (), () });
150	stat_type_stats!(YearByYear { Map<WithSeason<hitting::__YearByYearStatsData>, BySeason>, Map<WithSeason<pitching::__YearByYearStatsData>, BySeason>, Map<WithSeason<catching::__YearByYearStatsData>, BySeason>, Map2D<WithPositionAndSeason<fielding::__YearByYearStatsData>, BySeason, ByPosition> });
151	stat_type_stats!(YearByYearAdvanced { Map<WithSeason<hitting::__YearByYearAdvancedStatsData>, BySeason>, Map<WithSeason<pitching::__YearByYearAdvancedStatsData>, BySeason>, (), () });
152	stat_type_stats!(Season { WithSeason<hitting::__SeasonStatsData>, WithSeason<pitching::__SeasonStatsData>, WithSeason<catching::__SeasonStatsData>, Map2D<WithPositionAndSeason<fielding::__SeasonStatsData>, BySeason, ByPosition> });
153	stat_type_stats!(Career { Career<hitting::__CareerStatsData>, Career<pitching::__CareerStatsData>, Career<catching::__CareerStatsData>, Career<fielding::__CareerStatsData> });
154	stat_type_stats!(SeasonAdvanced { WithSeason<hitting::__SeasonAdvancedStatsData>, WithSeason<pitching::__SeasonAdvancedStatsData>, (), () });
155	stat_type_stats!(CareerAdvanced { Career<hitting::__CareerAdvancedStatsData>, Career<pitching::__CareerAdvancedStatsData>, (), () });
156	stat_type_stats!(GameLog { Vec<WithGame<hitting::__GameLogStatsData>>, Vec<WithGame<pitching::__GameLogStatsData>>, Vec<WithGame<catching::__GameLogStatsData>>, Vec<WithGame<fielding::__GameLogStatsData>> });
157	stat_type_stats!(PlayLog { Vec<SingleMatchup<PlayStat>>, Vec<SingleMatchup<PlayStat>>, Vec<SingleMatchup<PlayStat>>, Vec<SingleMatchup<PlayStat>> });
158	stat_type_stats!(PitchLog { Vec<SingleMatchup<PitchStat>>, Vec<SingleMatchup<PitchStat>>, Vec<SingleMatchup<PitchStat>>, Vec<SingleMatchup<PitchStat>> });
159	// 'metricLog'?
160	// 'metricAverages'?
161	// stat_type_stats!(PitchArsenal { Vec<PitchUsage>, Vec<PitchUsage>, (), () }); // has no stat group
162	// 'outsAboveAverage'?
163	stat_type_stats!(ExpectedStatistics { WithPlayer<hitting::__ExpectedStatisticsStatsData>, WithPlayer<pitching::__ExpectedStatisticsStatsData>, (), () });
164	stat_type_stats!(Sabermetrics { WithPlayer<hitting::__SabermetricsStatsData>, WithPlayer<pitching::__SabermetricsStatsData>, (), () });
165	// stat_type_stats!(SprayChart { SprayChart, SprayChart, (), () }); // does not have statGroup on the response
166	// 'tracking'?
167	// stat_type_stats!(VsPlayer { AccumulatedMatchup<VsPlayerHittingStats>, AccumulatedMatchup<VsPlayerPitchingStats>, (), () });
168	// stat_type_stats!(VsPlayerTotal { AccumulatedMatchup<VsPlayerHittingStats>, AccumulatedMatchup<VsPlayerPitchingStats>, (), () });
169	stat_type_stats!(VsPlayer5Y { AccumulatedVsPlayerMatchup<hitting::__VsPlayerStatsData>, AccumulatedVsPlayerMatchup<pitching::__VsPlayerStatsData>, (), () });
170	// stat_type_stats!(VsTeam { Multiple<AccumulatedVsTeamSeasonalPitcherSplit<HittingStats>>, (), (), () });
171	// stat_type_stats!(VsTeam5Y { Multiple<AccumulatedVsTeamSeasonalPitcherSplit<HittingStats>>, (), (), () });
172	// stat_type_stats!(VsTeamTotal { AccumulatedVsTeamTotalMatchup<HittingStats>, (), (), () });
173	stat_type_stats!(LastXGames { WithTeam<hitting::__LastXGamesStatsData>, WithTeam<pitching::__LastXGamesStatsData>, WithTeam<catching::__LastXGamesStatsData>, WithTeam<fielding::__LastXGamesStatsData> });
174	stat_type_stats!(ByDateRange { WithTeam<hitting::__ByDateRangeStatsData>, WithTeam<pitching::__ByDateRangeStatsData>, WithTeam<catching::__ByDateRangeStatsData>, WithTeam<fielding::__ByDateRangeStatsData> });
175	stat_type_stats!(ByDateRangeAdvanced { WithTeam<hitting::__ByDateRangeAdvancedStatsData>, WithTeam<pitching::__ByDateRangeAdvancedStatsData>, WithTeam<catching::__ByDateRangeAdvancedStatsData>, WithTeam<fielding::__ByDateRangeAdvancedStatsData> });
176	stat_type_stats!(ByMonth { Map<WithMonth<hitting::__ByMonthStatsData>, ByMonth>, Map<WithMonth<pitching::__ByMonthStatsData>, ByMonth>, Map<WithMonth<catching::__ByMonthStatsData>, ByMonth>, Map<WithMonth<fielding::__ByMonthStatsData>, ByMonth> });
177	stat_type_stats!(ByDayOfWeek { Map<WithWeekday<hitting::__ByDayOfWeekStatsData>, ByWeekday>, Map<WithWeekday<pitching::__ByDayOfWeekStatsData>, ByWeekday>, Map<WithWeekday<catching::__ByDayOfWeekStatsData>, ByWeekday>, Map<WithWeekday<fielding::__ByDayOfWeekStatsData>, ByWeekday> });
178	stat_type_stats!(HomeAndAway { WithHomeAndAway<hitting::__HomeAndAwayStatsData>, WithHomeAndAway<pitching::__HomeAndAwayStatsData>, WithHomeAndAway<catching::__HomeAndAwayStatsData>, WithHomeAndAway<fielding::__HomeAndAwayStatsData> });
179	stat_type_stats!(WinLoss { WithWinLoss<hitting::__WinLossStatsData>, WithWinLoss<pitching::__WinLossStatsData>, WithWinLoss<catching::__WinLossStatsData>, WithWinLoss<fielding::__WinLossStatsData> });
180	// stat_type_stats!(Rankings { WithPlayerAndTeam<hitting::__RankingsStatsData>, WithPlayerAndTeam<pitching::__RankingsStatsData>, (), () });
181	// stat_type_stats!(RankingsByYear { Map<WithPlayerAndTeam<hitting::__RankingsByYearStatsData>, BySeason>, Map<WithPlayerAndTeam<pitching::__RankingsByYearStatsData>, BySeason>, (), () });
182	// stat_type_stats!(HotColdZones { HittingHotColdZones, PitchingHotColdZones, (), () }); // has no stat group
183	stat_type_stats!(OpponentsFaced { Vec<FieldedMatchup>, Vec<FieldedMatchup>, Vec<FieldedMatchup>, Vec<FieldedMatchup> });
184	stat_type_stats!(StatSplits { WithSeason<hitting::__StatSplitsStatsData>, WithSeason<pitching::__StatSplitsStatsData>, (), () });
185	stat_type_stats!(StatSplitsAdvanced { WithSeason<hitting::__StatSplitsAdvancedStatsData>, WithSeason<pitching::__StatSplitsAdvancedStatsData>, (), () });
186	// stat_type_stats!(AtGameStart { Multiple<WithGame<hitting::AtGameStart>>, Multiple<WithGame<pitching::AtGameStart>>, Multiple<WithGame<catching::AtGameStart>>, Multiple<WithGame<fielding::AtGameStart>> });
187	// 'vsOpponents'?
188	stat_type_stats!(Boxscore { WithNone<hitting::__BoxscoreStatsData>, WithNone<pitching::__BoxscoreStatsData>, (), WithNone<fielding::__BoxscoreStatsData>, });
189}
mlb_api/requests/stats/mod.rs

mlb_api/requests/stats/
mod.rs
