Struct f1_api::packet::header::Header

pub struct Header { /* fields omitted */ }

Header prefixing each packet

The modern F1 games use versioned API specifications. Each packet is prefixed with a header that declares which version of the specification the packet adheres to. This information is required to decode the packet correctly. Because it is only relevant for decoding the packet, the packet format, type, and version from the specifications are not republished.

The header also contains information about the session the packet belongs to, and about the time the packet was created.

TODO Verify that the session tie can be represented as a duration

Methods

impl Header

pub fn new(
    api_spec: ApiSpec,
    game_version: Option<GameVersion>,
    packet_type: PacketType,
    session_uid: u64,
    session_time: Duration,
    frame_identifier: u32,
    player_car_index: VehicleIndex
) -> Self

Constructs a new Header.

impl Header

pub fn game_version(&self) -> &Option<GameVersion>

Returns the version of the game.

pub fn session_time(&self) -> &Duration

Returns the session time at the time the packet was sent.

impl Header

pub fn api_spec(&self) -> ApiSpec

Returns the API specification that was used to decode the packet.

pub fn packet_type(&self) -> PacketType

Returns the type of the packet.

The packet type is only required to determine how to decode the packet. After decoding it, the packet type is represented by Rust's type system.

pub fn session_uid(&self) -> u64

Returns the unique session UID.

pub fn frame_identifier(&self) -> u32

Returns the frame identifier at the time the packet was sent.

pub fn player_car_index(&self) -> VehicleIndex

Returns the player's car index.

The setups and status of cars are published as arrays. This field indicates which position in these arrays the player's car has.

Trait Implementations

impl Clone for Header

fn clone(&self) -> Header

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Header

impl Debug for Header

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

Formats the value using the given formatter.

impl Display for Header

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

Formats the value using the given formatter.

impl Eq for Header

impl Hash for Header

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl Ord for Header

fn cmp(&self, other: &Header) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<Header> for Header

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<Header> for Header

fn partial_cmp(&self, other: &Header) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Header) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Header) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Header) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Header) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for Header

impl StructuralPartialEq for Header