tba_openapi_rust/models/
model_match.rs

1/*
2 * The Blue Alliance API v3
3 *
4 * # Overview    Information and statistics about FIRST Robotics Competition teams and events.   # Authentication   All endpoints require an Auth Key to be passed in the header `X-TBA-Auth-Key`. If you do not have an auth key yet, you can obtain one from your [Account Page](/account).
5 *
6 * The version of the OpenAPI document: 3.8.2
7 * 
8 * Generated by: https://openapi-generator.tech
9 */
10
11
12
13
14#[derive(Clone, Debug, PartialEq, Default, Serialize, Deserialize)]
15pub struct Match {
16    /// TBA match key with the format `yyyy[EVENT_CODE]_[COMP_LEVEL]m[MATCH_NUMBER]`, where `yyyy` is the year, and `EVENT_CODE` is the event code of the event, `COMP_LEVEL` is (qm, ef, qf, sf, f), and `MATCH_NUMBER` is the match number in the competition level. A set number may be appended to the competition level if more than one match in required per set.
17    #[serde(rename = "key")]
18    pub key: String,
19    /// The competition level the match was played at.
20    #[serde(rename = "comp_level")]
21    pub comp_level: CompLevel,
22    /// The set number in a series of matches where more than one match is required in the match series.
23    #[serde(rename = "set_number")]
24    pub set_number: i32,
25    /// The match number of the match in the competition level.
26    #[serde(rename = "match_number")]
27    pub match_number: i32,
28    #[serde(rename = "alliances", skip_serializing_if = "Option::is_none")]
29    pub alliances: Option<Box<crate::models::MatchSimpleAlliances>>,
30    /// The color (red/blue) of the winning alliance. Will contain an empty string in the event of no winner, or a tie.
31    #[serde(rename = "winning_alliance", skip_serializing_if = "Option::is_none")]
32    pub winning_alliance: Option<WinningAlliance>,
33    /// Event key of the event the match was played at.
34    #[serde(rename = "event_key")]
35    pub event_key: String,
36    /// UNIX timestamp (seconds since 1-Jan-1970 00:00:00) of the scheduled match time, as taken from the published schedule.
37    #[serde(rename = "time", skip_serializing_if = "Option::is_none")]
38    pub time: Option<i64>,
39    /// UNIX timestamp (seconds since 1-Jan-1970 00:00:00) of actual match start time.
40    #[serde(rename = "actual_time", skip_serializing_if = "Option::is_none")]
41    pub actual_time: Option<i64>,
42    /// UNIX timestamp (seconds since 1-Jan-1970 00:00:00) of the TBA predicted match start time.
43    #[serde(rename = "predicted_time", skip_serializing_if = "Option::is_none")]
44    pub predicted_time: Option<i64>,
45    /// UNIX timestamp (seconds since 1-Jan-1970 00:00:00) when the match result was posted.
46    #[serde(rename = "post_result_time", skip_serializing_if = "Option::is_none")]
47    pub post_result_time: Option<i64>,
48    /// Score breakdown for auto, teleop, etc. points. Varies from year to year. May be null.
49    #[serde(rename = "score_breakdown", skip_serializing_if = "Option::is_none")]
50    pub score_breakdown: Option<serde_json::Value>,
51    /// Array of video objects associated with this match.
52    #[serde(rename = "videos", skip_serializing_if = "Option::is_none")]
53    pub videos: Option<Vec<crate::models::MatchVideosInner>>,
54}
55
56impl Match {
57    pub fn new(key: String, comp_level: CompLevel, set_number: i32, match_number: i32, event_key: String) -> Match {
58        Match {
59            key,
60            comp_level,
61            set_number,
62            match_number,
63            alliances: None,
64            winning_alliance: None,
65            event_key,
66            time: None,
67            actual_time: None,
68            predicted_time: None,
69            post_result_time: None,
70            score_breakdown: None,
71            videos: None,
72        }
73    }
74}
75
76/// The competition level the match was played at.
77#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
78pub enum CompLevel {
79    #[serde(rename = "qm")]
80    Qm,
81    #[serde(rename = "ef")]
82    Ef,
83    #[serde(rename = "qf")]
84    Qf,
85    #[serde(rename = "sf")]
86    Sf,
87    #[serde(rename = "f")]
88    F,
89}
90
91impl Default for CompLevel {
92    fn default() -> CompLevel {
93        Self::Qm
94    }
95}
96/// The color (red/blue) of the winning alliance. Will contain an empty string in the event of no winner, or a tie.
97#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
98pub enum WinningAlliance {
99    #[serde(rename = "red")]
100    Red,
101    #[serde(rename = "blue")]
102    Blue,
103    #[serde(rename = "")]
104    Empty,
105}
106
107impl Default for WinningAlliance {
108    fn default() -> WinningAlliance {
109        Self::Red
110    }
111}
112
tba_openapi_rust/models/model_match.rs

tba_openapi_rust/models/
model_match.rs
