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 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262
//! Events that can occur during the course of a session //! //! The F1 games send event packets whenever certain events occur in a session. _F1 2018_ defined //! only two events, but _F1 2019_ extended this to nine different events. Some events carry a //! payload that further defines the event, and that are declared in this module as structs. use crate::packet::header::Header; use crate::types::VehicleIndex; use derive_new::new; use getset::{CopyGetters, Getters}; use std::fmt; use std::fmt::Display; use std::time::Duration; /// Payload for fastest lap event /// /// The fastest lap event contains the driver achieving the fastest lap as well as the lap time as /// its payload. The driver is referenced through the vehicle index, while the lap time is provided /// in seconds. /// /// # Examples /// /// ``` /// # use f1_api::packet::event::{FastestLap, Event}; /// # use std::time::Duration; /// # /// # let fastest_lap = FastestLap::new(0, Duration::from_secs(62)); /// # let event = Event::FastestLap(fastest_lap); /// # /// // Simplified use in a match statement /// match event { /// Event::FastestLap(lap) => { /// assert_eq!(0, lap.vehicle_index()); /// assert_eq!(62, lap.time().as_secs()); /// } /// # _ => panic!("Example should never fail") /// } /// ``` #[derive( new, Debug, Getters, CopyGetters, PartialEq, Copy, Clone, Eq, Ord, PartialOrd, Hash, Default, )] pub struct FastestLap { /// Returns the index of the car achieving the fastest lap. #[getset(get_copy = "pub")] vehicle_index: VehicleIndex, /// Returns the time of the fastest lap. #[getset(get = "pub")] time: Duration, } impl Display for FastestLap { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { write!( f, "{}s by car #{}", self.time.as_secs_f32(), self.vehicle_index ) } } /// Payload for retirement event /// /// The retirement event contains the vehicle index of the retired driver as its payload. /// /// # Examples /// /// ``` /// # use f1_api::packet::event::{Event, Retirement}; /// # /// # let retirement = Retirement::new(0); /// # let event = Event::Retirement(retirement); /// # /// // Simplified use in a match statement /// match event { /// Event::Retirement(retirement) => { /// assert_eq!(0, retirement.vehicle_index()); /// } /// # _ => panic!("Example should never fail") /// } /// ``` #[derive( new, Debug, Getters, CopyGetters, PartialEq, Copy, Clone, Eq, Ord, PartialOrd, Hash, Default, )] pub struct Retirement { /// Returns the index of the car retiring. #[getset(get_copy = "pub")] vehicle_index: VehicleIndex, } impl Display for Retirement { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { write!(f, "retirement of car #{}", self.vehicle_index) } } /// Payload for teammate in pits event /// /// When a teammate enters the pits, an event is sent carrying the vehicle index of the teammate as /// its payload. /// /// # Examples /// /// ``` /// # use f1_api::packet::event::{Event, TeammateInPits}; /// # /// # let teammate_in_pits = TeammateInPits::new(0); /// # let event = Event::TeammatesInPits(teammate_in_pits); /// # /// // Simplified use in a match statement /// match event { /// Event::TeammatesInPits(teammate) => { /// assert_eq!(0, teammate.vehicle_index()); /// } /// # _ => panic!("Example should never fail") /// } /// ``` #[derive( new, Debug, Getters, CopyGetters, PartialEq, Copy, Clone, Eq, Ord, PartialOrd, Hash, Default, )] pub struct TeammateInPits { /// Returns the index of the teammate who has just entered the pits. #[getset(get_copy = "pub")] vehicle_index: VehicleIndex, } impl Display for TeammateInPits { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { write!(f, "teammate in car #{} in pits", self.vehicle_index) } } /// Payload for the race winner event /// /// The event announcing the race winner carries the vehicle index of the winner as its payload. /// /// # Examples /// /// ``` /// # use f1_api::packet::event::{Event, RaceWinner}; /// # /// # let race_winner = RaceWinner::new(0); /// # let event = Event::RaceWinner(race_winner); /// # /// // Simplified use in a match statement /// match event { /// Event::RaceWinner(winner) => { /// assert_eq!(0, winner.vehicle_index()); /// } /// # _ => panic!("Example should never fail") /// } /// ``` #[derive( new, Debug, Getters, CopyGetters, PartialEq, Copy, Clone, Eq, Ord, PartialOrd, Hash, Default, )] pub struct RaceWinner { /// Returns the index of the car that has won the race. #[getset(get_copy = "pub")] vehicle_index: VehicleIndex, } impl Display for RaceWinner { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { write!(f, "race winner in car #{}", self.vehicle_index) } } /// Events that can occur during the course of a session /// /// The F1 games send event packets whenever a certain event occurs in a session. Depending on the /// game, only a subset of the defined events may be published. Some events carry a payload that /// further describes the event. For example, the event declaring the race winner sends with it the /// vehicle index of said winner. #[derive(Debug, PartialEq, Copy, Clone, Eq, Ord, PartialOrd, Hash)] pub enum Event { /// The chequered flag signals the end of the race. ChequeredFlag, /// DRS is disabled at the beginning of the race, and can be disabled throughout the race in /// case of poor weather conditions or yellow flags in the DRS activation zone. DrsDisabled, /// DRS gets enabled after the first two laps of a race. In case DRS is disabled during a race, /// e.g. due to poor weather conditions, it can be re-enabled once the conditions have cleared. DrsEnabled, /// When a driver achieves the fastest lap of the race, the event publishes the driver and their /// time. FastestLap(FastestLap), /// At the end of the race, the race winner is announced in an event. RaceWinner(RaceWinner), /// Drivers can retire from a race, for example after their car suffers technical issues. The /// retirement is announced as an event with the driver as the payload. Retirement(Retirement), /// The end of a session is announced in an event. SessionEnded, /// The start of a session is announced in an event. SessionStarted, /// When a teammate enters the pits, an event carrying their vehicle index is published. TeammatesInPits(TeammateInPits), } impl Default for Event { fn default() -> Self { Event::SessionStarted } } impl Display for Event { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { match self { Event::SessionStarted => write!(f, "Session started"), Event::SessionEnded => write!(f, "Session ended"), Event::FastestLap(lap) => write!( f, "Fastest lap by car #{} ({}s)", lap.vehicle_index, lap.time.as_secs_f32() ), Event::Retirement(retirement) => write!(f, "Car #{} retired", retirement.vehicle_index), Event::DrsEnabled => write!(f, "DRS enabled"), Event::DrsDisabled => write!(f, "DRS disabled"), Event::TeammatesInPits(teammate) => { write!(f, "Teammate in car #{} in pits", teammate.vehicle_index) } Event::ChequeredFlag => write!(f, "Chequered flag"), Event::RaceWinner(winner) => write!(f, "Car #{} won the race", winner.vehicle_index), } } } /// Packet containing details about an event that occurred in the session /// /// The modern F1 games send event packets with details about events that occur in a session. The /// frequency with which these packets are sent is not fixed, but rather packets are sent whenever /// events occur. #[derive(new, Debug, Getters, PartialEq, Copy, Clone, Eq, Ord, PartialOrd, Hash)] pub struct EventPacket { /// Returns the packet header prefixing the event packet. #[getset(get = "pub")] header: Header, /// Returns the event from the event packet. #[getset(get = "pub")] event: Event, } impl Display for EventPacket { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { write!( f, "EventPacket {{ header: {}, event: {} }}", self.header, self.event ) } }