Struct IoFlags 

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

Flags that can be used with Input, Output, or Feature items.

Example

let flags = IoFlags::data().variable().null_state();
assert_eq!(u32::from(flags), 0x42);

Implementations

impl IoFlags

pub const fn from_bits(bits: u32) -> Self

Convert from bits.

pub const fn into_bits(self) -> u32

Convert into bits.

impl IoFlags

pub const fn data() -> Self

Construct a new IoFlags for a data field.

pub const fn constant() -> Self

Construct a new IoFlags for a constant field.

pub const fn is_constant(self) -> bool

Test if this is a constant field.

pub const fn is_data(self) -> bool

Test if this is a data field.

pub const fn variable(self) -> Self

The field stores a variable.

By default fields store an array.

pub const fn is_variable(self) -> bool

Test if this is a variable field.

pub const fn is_array(self) -> bool

Test if this is an array field.

pub const fn relative(self) -> Self

The field holds a relative value.

By default values are absolute.

pub const fn is_relative(self) -> bool

Test if this field is relative.

pub const fn is_absolute(self) -> bool

Test if this field is absolute.

pub const fn wrap(self) -> Self

The value wraps around in the positive and negative directions.

By default values do not wrap.

pub const fn wraps(self) -> bool

Test if this field wraps.

pub const fn non_linear(self) -> Self

The value is non-linear.

By default values are linear.

pub const fn is_linear(self) -> bool

Test if this field is linear.

pub const fn no_preferred_state(self) -> Self

The value has no preferred state.

Preferred state means that a control will return to some state when it’s not being used. Buttons or joysticks are examples of controls with a preferred state.

By default values have a preferred state.

pub const fn has_preferred_state(self) -> bool

Test if this field has a preferred state.

pub const fn null_state(self) -> Self

The control has a null state.

A null state is a value outside the logical minimum-maximum range, used to indicate that the control is not active (such as a hat switch).

By default controls have no null position.

pub const fn has_null_state(self) -> bool

Test if this field has a null state.

pub const fn volatile(self) -> Self

The value is volatile.

A volatile value is one that can change without host interaction.

By default a value is non-volatile.

This flag is only used for Output or Feature items.

pub const fn is_volatile(self) -> bool

Test if this field is volatile.

pub const fn buffered(self) -> Self

The value is buffered.

Buffered data is not a single numeric quantity, but instead part of a stream of bytes (for example data from a barcode reader).

By default a value is a bit field.

pub const fn is_buffered(self) -> bool

Test if this field is buffered.

pub const fn is_bitfield(self) -> bool

Test if this field is a bit field.

Trait Implementations

impl Clone for IoFlags

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for IoFlags

impl Default for IoFlags

fn default() -> Self

Returns the “default value” for a type.

impl From<IoFlags> for u32

fn from(v: IoFlags) -> Self

Converts to this type from the input type.

impl From<IoFlags> for OutputFeatureFlags

fn from(flags: IoFlags) -> Self

Convert an IoFlags value.

Note that unline InputFlags, all IoFlags values are valid Output or Feature flags.

impl From<u32> for IoFlags

fn from(v: u32) -> Self

Converts to this type from the input type.

impl PartialEq for IoFlags

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for IoFlags