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
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

use serde::Deserialize;

id!(#[doc = "A [`String`] representing the [`GameStatus`]"] GameStatusId { detailedState: String });

/// Detailed game status (use [`AbstractGameCode`] for simpler responses)
#[derive(Debug, Deserialize, PartialEq, Eq, Copy, Clone)]
pub enum CodedGameState {
	/// Game has not begun, but is scheduled to occur
	#[serde(rename = "S")]
	Scheduled,

	/// Game is currently undergoing pregame activities (such as warming up, or a slight delay before start)
	#[serde(rename = "P")]
	PreGame,

	/// Game is underway.
	#[serde(rename = "I")]
	InProgress,

	/// Manager is submitting a challenge
	#[serde(rename = "M")]
	ManagerChallenge,

	/// Umpires are reviewing a play
	#[serde(rename = "N")]
	UmpireReview,

	/// Game is postponed; has not begun but moved to a later date -- typically double-header.
	#[serde(rename = "D")]
	Postponed,

	/// Game is canceled and never began. Removed from total # of games played, no rescheduling.
	#[serde(rename = "C")]
	Cancelled,

	/// Game was finished.
	#[serde(rename = "F", alias = "O")] // unaware of the difference
	Finished,

	/// Game was suspended, will be played on a later date.
	#[serde(rename = "T", alias = "U")] // unaware of the difference
	Suspended,

	/// Game was forfeited.
	#[serde(rename = "Q", alias = "R")] // unaware of the difference
	Forfeit,

	/// Game is being written?? (Likely means that the official scorer is in the process of doing the finishing touches)
	#[serde(rename = "W")]
	Writing,

	/// Game state is unknown (typically assume the game was completed)
	#[serde(rename = "X")]
	Unknown,
}

/// Basic game status code, describes whether the game is in the past (finished), present (underway), or future (scheduled).
#[derive(Debug, Deserialize, PartialEq, Eq, Copy, Clone)]
pub enum AbstractGameCode {
	/// Game has not begun
	#[serde(rename = "P")]
	Preview,

	/// Game is underway
	#[serde(rename = "L")]
	Live,

	/// Game is finished
	#[serde(rename = "F")]
	Finished,

	/// Used for [`CodedGameStatus::Writing`] and [`CodedGameStatus::Unknown`], typically best to assume game is finished.
	#[serde(rename = "O")]
	Other,
}

impl AbstractGameCode {
	#[must_use]
	pub const fn has_begun(self) -> bool {
		matches!(self, Self::Live | Self::Finished | Self::Other)
	}

	#[must_use]
	pub const fn has_ended(self) -> bool {
		matches!(self, Self::Finished | Self::Other)
	}

	#[must_use]
	pub const fn is_preview(self) -> bool {
		matches!(self, Self::Preview)
	}

	#[must_use]
	pub const fn is_live(self) -> bool {
		matches!(self, Self::Live)
	}

	#[must_use]
	pub const fn is_finished(self) -> bool {
		matches!(self, Self::Finished)
	}

	#[must_use]
	pub const fn is_unknown(self) -> bool {
		matches!(self, Self::Other)
	}
}

// State of the game as of the current moment.
#[derive(Debug, Deserialize, Clone)]
#[serde(rename_all = "camelCase")]
pub struct GameStatus {
	pub abstract_game_state: String,
	pub coded_game_state: CodedGameState,
	pub status_code: String,
	pub reason: Option<String>,
	pub abstract_game_code: AbstractGameCode,
	#[serde(flatten)]
	pub id: GameStatusId,
}

id_only_eq_impl!(GameStatus, id);
meta_kind_impl!("gameStatus" => GameStatus);
tiered_request_entry_cache_impl!(GameStatus.id: GameStatusId);
test_impl!(GameStatus);