Trait BitmaskTrait

pub trait BitmaskTrait {
    type Array: Sized;
    type Index: Copy + IterableEnum;

    const ZERO: Self::Array;

    // Required methods
    fn array_default() -> Self::Array;
    fn array_slice(array: &Self::Array) -> &[u8] ;
    fn array_slice_mut(array: &mut Self::Array) -> &mut [u8] ;
    fn index(index: Self::Index) -> usize;

    // Provided method
    fn index_valid(_array: &Self::Array, _index: Self::Index) -> bool { ... }
}

A generic trait that can be used to index by a given type into a set of bits.

Required Associated Constants

const ZERO: Self::Array

Empty default data.

Required Associated Types

type Array: Sized

The underlying array storage data type.

type Index: Copy + IterableEnum

The type that the bitmask can be indexed by.

Required Methods

fn array_default() -> Self::Array

The default empty state of the bitmask.

fn array_slice(array: &Self::Array) -> &[u8]

A representation of the bitmask as a slice of bytes.

fn array_slice_mut(array: &mut Self::Array) -> &mut [u8]

A mutable representation of the bitmask as a slice of bytes.

fn index(index: Self::Index) -> usize

Computes a normalized index value.

Provided Methods

fn index_valid(_array: &Self::Array, _index: Self::Index) -> bool

Validates whether a given index is valid and in range for the bitmask.

Dynamically allocated bitmasks may not be large enough to contain all indices.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl BitmaskTrait for Vec<u8>

const ZERO: Self

type Array = Vec<u8>

type Index = u16

fn array_default() -> Self::Array

fn array_slice(array: &Self::Array) -> &[u8]

fn array_slice_mut(array: &mut Self::Array) -> &mut [u8]

fn index(index: Self::Index) -> usize

fn index_valid(array: &Self::Array, index: Self::Index) -> bool

Implementors

impl BitmaskTrait for AbsoluteAxis

const ZERO: Self::Array

type Array = [u8; 8]

type Index = AbsoluteAxis

impl BitmaskTrait for AutorepeatKind

const ZERO: Self::Array

type Array = [u8; 1]

type Index = AutorepeatKind

impl BitmaskTrait for EventKind

const ZERO: Self::Array

type Array = [u8; 4]

type Index = EventKind

impl BitmaskTrait for ForceFeedbackKind

const ZERO: Self::Array

type Array = [u8; 16]

type Index = ForceFeedbackKind

impl BitmaskTrait for ForceFeedbackStatusKind

const ZERO: Self::Array

type Array = [u8; 1]

type Index = ForceFeedbackStatusKind

impl BitmaskTrait for InputProperty

const ZERO: Self::Array

type Array = [u8; 4]

type Index = InputProperty

impl BitmaskTrait for Key

const ZERO: Self::Array

type Array = [u8; 96]

type Index = Key

impl BitmaskTrait for LedKind

const ZERO: Self::Array

type Array = [u8; 2]

type Index = LedKind

impl BitmaskTrait for MiscKind

const ZERO: Self::Array

type Array = [u8; 1]

type Index = MiscKind

impl BitmaskTrait for RelativeAxis

const ZERO: Self::Array

type Array = [u8; 2]

type Index = RelativeAxis

impl BitmaskTrait for SoundKind

const ZERO: Self::Array

type Array = [u8; 1]

type Index = SoundKind

impl BitmaskTrait for SwitchKind

const ZERO: Self::Array

type Array = [u8; 3]

type Index = SwitchKind

impl BitmaskTrait for SynchronizeKind

const ZERO: Self::Array

type Array = [u8; 2]

type Index = SynchronizeKind

impl BitmaskTrait for UInputKind

const ZERO: Self::Array

type Array = [u8; 1]

type Index = UInputKind