Struct Key_CEnum

#[repr(transparent)]
pub struct Key_CEnum(pub u32);

Auto-generated FFI type for Key.

When use this?

C’s enum is really just a number and there is no guarantee that it will fit within the enum. Therefore, it is used for the following cases that cannot be controlled by Rust.

• C++ members
• Function return values.

When not to use it?

Mainly those that can be controlled for safety on the Rust side.

• Function Arguments

Convenient methods

• to_enum/from_enum: To inter-convert enums.
• count: Returns the number of defined discriminants.

Memory Layout

It will always have #[repr(transparent)]. In other words, it is equivalent to the size specified in repr.

Tuple Fields

0: u32

Implementations

impl Key_CEnum

pub const Up: Self

pub const Down: Self

pub const Left: Self

pub const Right: Self

pub const Start: Self

pub const Back: Self

pub const LeftThumb: Self

pub const RightThumb: Self

pub const LeftShoulder: Self

pub const RightShoulder: Self

pub const A: Self

pub const B: Self

pub const X: Self

pub const Y: Self

pub const LeftTrigger: Self

pub const RightTrigger: Self

pub const LeftStick: Self

pub const RightStick: Self

pub const fn to_enum(self) -> Option<Key>

Converts to the corresponding enum variant.

Returns Some(Key) if the value is valid, otherwise None.

pub const fn from_enum(e: Key) -> Self

Creates the struct from the enum.

This allows for easy conversion back to the FFI-friendly representation.

pub const fn count() -> usize

Number of discriminant in enum.

Returns 18

Trait Implementations

impl Clone for Key_CEnum

fn clone(&self) -> Key_CEnum

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Key_CEnum

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

Formats the value using the given formatter.

impl Default for Key_CEnum

fn default() -> Self

Returns the “default value” for a type.

impl From<Key> for Key_CEnum

fn from(value: Key) -> Self

Converts to this type from the input type.

impl Hash for Key_CEnum

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 Key_CEnum

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

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Key_CEnum

fn partial_cmp(&self, other: &Key_CEnum) -> 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 TryFrom<Key_CEnum> for Key

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(value: Key_CEnum) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for Key_CEnum

impl Eq for Key_CEnum

impl StructuralPartialEq for Key_CEnum