Crate iracing_telem

Crate iracing_telem 

Source
Expand description

iracing-telem is a rust port of the iRacing provided c++ SDK.

It allows for access to telemetetry data from a running instance of the iRacing simulator As well as the ability to send certain control messages to the simulator (e.g to change Pitstop settings)

The iRacing data is exposed through a memory mapped file. Because of this, and the potential issue for the data to not be in the expected locations almost all methods are marked as unsafe.

Details of the c++ SDK are available on the iRacing forums. Note you will need an active iRacing subsription to access these.

https://forums.iracing.com/discussion/62/iracing-sdk

Modules§

flags
flags contains definitions for the Bitfield and Enum values that are returned as variable values.

Structs§

Client
Client is main entry point into the library. Create a client and then you can access Sessions that have the telemetry data in then.
Session
A Session is used to access data from iRacing.
Var
Var is a handle to a variable or telemetry data point.

Enums§

DataUpdateResult
The outcome of trying to read a row of telemetery data.
Error
These errors can be returned when accessing variable values and there is a mismatch between the type of the variable, and the type of value asked for.
Value
An instance of a value for a variable.
VarType
The different types of variables or datapoints available.

Constants§

IRSDK_UNLIMITED_LAPS
define markers for unlimited session laps
IRSDK_UNLIMITED_TIME
define markers for unlimited session time (in seconds)