Struct iracing::telemetry::Sample

pub struct Sample { /* fields omitted */ }

Sample represents a single sample of telemetry data from iRacing either from live telemetry, or from a telemetry file.

Implementations

impl Sample

pub fn has(&self, name: &'static str) -> bool

Check if a given variable is available in the telemetry sample

pub fn all(&self) -> Vec<ValueDescription>

Gets all values in the same along with names and descriptions.

Returns a vec of all values in the telemetry sample, along with additional metadata such as the name, description, unit and value count.

Note: This method is expensive and will return a large number of values. It should be used primarily for debugging, and for most use cases Selecting only the values required with get() is suggested.

pub fn get(&self, name: &'static str) -> Result<Value, String>

Get a Value from the sample.

Read a single varialbe from the telemetry sample.

Returns Ok(Value) if the telemetry value is available. Returns Err(String) if the value cannot be found.

Parameters

name Name of the telemetry variable to get

• see the iRacing Telemtry documentation for a complete list of possible values

Trait Implementations

impl Debug for Sample

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

Formats the value using the given formatter.

impl Default for Sample

pub fn default() -> Sample

Returns the "default value" for a type.