Struct TelemetryApiVersion 

pub struct TelemetryApiVersion(/* private fields */);

Version of the ABI negotiated through scs_telemetry_init.

The game tries supported API versions from newest to oldest. A plugin must accept only layouts it has explicitly audited and return unsupported for every other value so the game can continue its normal fallback sequence.

This is intentionally a newtype rather than a closed enum. Future SCS versions can be represented and logged before the wrapper has added a safe adapter for their initialization structure.

Implementations

impl TelemetryApiVersion

pub const V1_00: Self

Initial telemetry API layout.

pub const V1_01: Self

Adds signed 64-bit values and gameplay events.

pub const CURRENT: Self

Latest telemetry API declared by the vendored SCS SDK headers.

pub const fn new(major: u32, minor: u32) -> Self

Creates a packed SCS version from its two components.

pub const fn from_raw(raw: u32) -> Self

Wraps the packed version supplied by the game without claiming support.

pub const fn raw(self) -> u32

Returns the packed representation used by the SCS ABI.

pub const fn major(self) -> u32

Major component. A change normally indicates an incompatible API.

pub const fn minor(self) -> u32

Minor component. SCS normally uses this for additive API changes.

Trait Implementations

impl Clone for TelemetryApiVersion

fn clone(&self) -> TelemetryApiVersion

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for TelemetryApiVersion

impl Debug for TelemetryApiVersion

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

Formats the value using the given formatter.

impl Display for TelemetryApiVersion

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

Formats the value using the given formatter.

impl Eq for TelemetryApiVersion

impl Hash for TelemetryApiVersion

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for TelemetryApiVersion

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for TelemetryApiVersion

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for TelemetryApiVersion

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl StructuralPartialEq for TelemetryApiVersion