Struct InputFlags 

pub struct InputFlags(pub IoFlags);

A wrapper indicating IoFlags that should be interpreted as Input flags.

Tuple Fields

0: IoFlags

Implementations

impl InputFlags

pub fn from_unchecked(flags: IoFlags) -> Self

Mark some flags as input flags, without checking if the bit pattern is sensible for an Input item.

Methods from Deref<Target = IoFlags>

pub fn into_bits(self) -> u32

Convert into bits.

pub fn is_constant(self) -> bool

Test if this is a constant field.

pub fn is_data(self) -> bool

Test if this is a data field.

pub fn variable(self) -> Self

The field stores a variable.

By default fields store an array.

pub fn is_variable(self) -> bool

Test if this is a variable field.

pub fn is_array(self) -> bool

Test if this is an array field.

pub fn relative(self) -> Self

The field holds a relative value.

By default values are absolute.

pub fn is_relative(self) -> bool

Test if this field is relative.

pub fn is_absolute(self) -> bool

Test if this field is absolute.

pub fn wrap(self) -> Self

The value wraps around in the positive and negative directions.

By default values do not wrap.

pub fn wraps(self) -> bool

Test if this field wraps.

pub fn non_linear(self) -> Self

The value is non-linear.

By default values are linear.

pub fn is_linear(self) -> bool

Test if this field is linear.

pub 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 fn has_preferred_state(self) -> bool

Test if this field has a preferred state.

pub 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 fn has_null_state(self) -> bool

Test if this field has a null state.

pub 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 fn is_volatile(self) -> bool

Test if this field is volatile.

pub 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 fn is_buffered(self) -> bool

Test if this field is buffered.

pub fn is_bitfield(self) -> bool

Test if this field is a bit field.

Trait Implementations

impl Clone for InputFlags

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 InputFlags

impl Debug for InputFlags

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

Formats the value using the given formatter.

impl Deref for InputFlags

type Target = IoFlags

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl PartialEq for InputFlags

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for InputFlags