Struct SdkIndex 

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

Zero-based index passed through the SDK’s explicit index field.

This selects one member of an indexed channel or configuration attribute, such as a wheel, H-shifter slot, or substance. The raw value sys::SCS_U32_NIL is reserved by SCS to represent a scalar descriptor and therefore has no SdkIndex representation.

Implementations

impl SdkIndex

pub const ZERO: Self

First zero-based SDK array element.

pub const fn new(raw: u32) -> Option<Self>

Creates an SDK index unless raw is the scalar sentinel.

pub const fn raw(self) -> u32

Returns the raw non-sentinel value used by the SCS ABI.

Trait Implementations

impl Clone for SdkIndex

fn clone(&self) -> SdkIndex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for SdkIndex

impl Debug for SdkIndex

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

Formats the value using the given formatter.

impl Display for SdkIndex

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

Formats the value using the given formatter.

impl Eq for SdkIndex

impl Hash for SdkIndex

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 SdkIndex

fn cmp(&self, other: &SdkIndex) -> 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 SdkIndex

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for SdkIndex

fn partial_cmp(&self, other: &SdkIndex) -> 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 SdkIndex