Struct Event

pub struct Event {

    pub key: String,
    pub name: String,
    pub event_code: String,
    pub event_type: i32,
    pub district: Option<Box<DistrictList>>,
    pub city: Option<String>,
    pub state_prov: Option<String>,
    pub country: Option<String>,
    pub start_date: String,
    pub end_date: String,
    pub year: i32,
    pub short_name: Option<String>,
    pub event_type_string: String,
    pub week: Option<i32>,
    pub address: Option<String>,
    pub postal_code: Option<String>,
    pub gmaps_place_id: Option<String>,
    pub gmaps_url: Option<String>,
    pub lat: Option<f64>,
    pub lng: Option<f64>,
    pub location_name: Option<String>,
    pub timezone: Option<String>,
    pub website: Option<String>,
    pub first_event_id: Option<String>,
    pub first_event_code: Option<String>,
    pub webcasts: Option<Vec<Webcast>>,
    pub division_keys: Option<Vec<String>>,
    pub parent_event_key: Option<String>,
    pub playoff_type: Option<i32>,
    pub playoff_type_string: Option<String>,
}

Fields

key: String

TBA event key with the format yyyy[EVENT_CODE], where yyyy is the year, and EVENT_CODE is the event code of the event.

name: String

Official name of event on record either provided by FIRST or organizers of offseason event.

event_code: String

Event short code, as provided by FIRST.

event_type: i32

Event Type, as defined here: https://github.com/the-blue-alliance/the-blue-alliance/blob/master/consts/event_type.py#L2

district: Option<Box<DistrictList>>

city: Option<String>

City, town, village, etc. the event is located in.

state_prov: Option<String>

State or Province the event is located in.

country: Option<String>

Country the event is located in.

start_date: String

Event start date in yyyy-mm-dd format.

end_date: String

Event end date in yyyy-mm-dd format.

year: i32

Year the event data is for.

short_name: Option<String>

Same as name but doesn’t include event specifiers, such as ‘Regional’ or ‘District’. May be null.

event_type_string: String

Event Type, eg Regional, District, or Offseason.

week: Option<i32>

Week of the event relative to the first official season event, zero-indexed. Only valid for Regionals, Districts, and District Championships. Null otherwise. (Eg. A season with a week 0 ‘preseason’ event does not count, and week 1 events will show 0 here. Seasons with a week 0.5 regional event will show week 0 for those event(s) and week 1 for week 1 events and so on.)

address: Option<String>

Address of the event’s venue, if available.

postal_code: Option<String>

Postal code from the event address.

gmaps_place_id: Option<String>

Google Maps Place ID for the event address.

gmaps_url: Option<String>

Link to address location on Google Maps.

lat: Option<f64>

Latitude for the event address.

lng: Option<f64>

Longitude for the event address.

location_name: Option<String>

Name of the location at the address for the event, eg. Blue Alliance High School.

timezone: Option<String>

Timezone name.

website: Option<String>

The event’s website, if any.

first_event_id: Option<String>

The FIRST internal Event ID, used to link to the event on the FRC webpage.

first_event_code: Option<String>

Public facing event code used by FIRST (on frc-events.firstinspires.org, for example)

webcasts: Option<Vec<Webcast>>

division_keys: Option<Vec<String>>

An array of event keys for the divisions at this event.

parent_event_key: Option<String>

The TBA Event key that represents the event’s parent. Used to link back to the event from a division event. It is also the inverse relation of divison_keys.

playoff_type: Option<i32>

Playoff Type, as defined here: https://github.com/the-blue-alliance/the-blue-alliance/blob/master/consts/playoff_type.py#L4, or null.

playoff_type_string: Option<String>

String representation of the playoff_type, or null.

Implementations

impl Event

pub fn new( key: String, name: String, event_code: String, event_type: i32, start_date: String, end_date: String, year: i32, event_type_string: String, ) -> Event

Trait Implementations

impl Clone for Event

fn clone(&self) -> Event

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Event

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Event

fn default() -> Event

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Event

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Event

fn eq(&self, other: &Event) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Event

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Event