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

use std::hash::{Hash, Hasher};
use derive_more::{Deref, DerefMut};
use serde::Deserialize;

id!(#[doc = "A [`String`] representing a position on the field, such as Pitcher, 1st Baseman, etc. These values use 1-9, so Pitcher = \"1\", etc."] PositionCode { code: String });

/// A [`Position`] with a name.
///
/// ## Examples
/// ```
/// NamedPosition {
///     code: "3".into(),
///     name: "First Base".into(),
///     r#type: "Infielder".into(),
///     abbreviation: "1B".into(),
/// }
/// ```
#[derive(Debug, Deserialize, Clone, Eq)]
#[serde(rename_all = "camelCase")]
pub struct NamedPosition {
	pub code: PositionCode,
	#[serde(alias = "displayName")]
	pub name: String,
	#[serde(rename = "type")]
	pub r#type: String,
	#[serde(alias = "abbrev")]
	pub abbreviation: String,
}

impl Hash for NamedPosition {
	fn hash<H: Hasher>(&self, state: &mut H) {
		self.code.hash(state);
	}
}

impl NamedPosition {
	#[must_use]
	pub fn unknown_position() -> Self {
		Self {
			code: PositionCode::new("X"),
			name: "Unknown".to_owned(),
			r#type: "Unknown".to_owned(),
			abbreviation: "X".to_owned(),
		}
	}
}

/// A Position with every piece of data you could describe about it.
///
/// ## Examples
/// ```
/// Position {
///     short_name: "1st Base".into(),
///     full_name: "First Base".into(),
///     abbreviation: "1B".into(),
///     code: "3".into(),
///     r#type: "Infielder".into(),
///     formal_name: "First Baseman".into(),
///     name: "First Base".into(),
///     is_pitcher: false,
///     is_game_position: true,
///     is_fielder: true,
///     is_outfield: false,
/// }
/// ```
#[allow(clippy::struct_excessive_bools, reason = "false positive")]
#[derive(Debug, Deserialize, Deref, DerefMut, Clone)]
#[serde(rename_all = "camelCase")]
pub struct Position {
	pub short_name: String,
	pub full_name: String,
	pub formal_name: String,
	#[serde(rename = "pitcher")]
	pub is_pitcher: bool,
	#[serde(rename = "gamePosition")]
	pub is_game_position: bool,
	#[serde(rename = "fielder")]
	pub is_fielder: bool,
	#[serde(rename = "outfield")]
	pub is_outfield: bool,

	#[deref]
	#[deref_mut]
	#[serde(flatten)]
	inner: NamedPosition,
}

impl Hash for Position {
	fn hash<H: Hasher>(&self, state: &mut H) {
		self.code.hash(state);
	}
}

impl Position {
	#[must_use]
	pub fn unknown_position() -> Self {
		Self {
			short_name: "Unknown".to_owned(),
			full_name: "Unknown".to_owned(),
			formal_name: "Unknown".to_owned(),
			is_pitcher: false,
			is_game_position: false,
			is_fielder: false,
			is_outfield: false,
			inner: NamedPosition::unknown_position(),
		}
	}
}

id_only_eq_impl!(Position, code);
id_only_eq_impl!(NamedPosition, code);
meta_kind_impl!("positions" => Position);
tiered_request_entry_cache_impl!([Position, NamedPosition].code: PositionCode);
test_impl!(Position);