Enum CapabilityRun

#[repr(u8)]
pub enum CapabilityRun {
    NoOp {
        state: CapabilityEvent,
    },
    Rotate {
        state: CapabilityEvent,
        index: u8,
        increment: i8,
    },
    LayerClear {
        state: CapabilityEvent,
    },
    LayerState {
        state: CapabilityEvent,
        layer: u8,
        layer_state: State,
    },
    LayerRotate {
        state: CapabilityEvent,
        direction: Direction,
    },
    HidProtocol {
        state: CapabilityEvent,
        mode: Protocol,
    },
    HidKeyboard {
        state: CapabilityEvent,
        id: Keyboard,
    },
    HidKeyboardState {
        state: CapabilityEvent,
        id: Keyboard,
        key_state: State,
    },
    HidConsumerControl {
        state: CapabilityEvent,
        id: ConsumerControl,
    },
    HidSystemControl {
        state: CapabilityEvent,
        id: SystemControl,
    },
    McuFlashMode {
        state: CapabilityEvent,
    },
    HidLed {
        state: CapabilityEvent,
        id: LedIndicator,
    },
    PixelAnimationControl {
        state: CapabilityEvent,
        mode: AnimationControl,
    },
    PixelAnimationIndex {
        state: CapabilityEvent,
        index: u16,
    },
    PixelFadeControl {
        state: CapabilityEvent,
        profile: u8,
        command: FadeCommand,
        arg: u8,
    },
    PixelFadeLayer {
        state: CapabilityEvent,
        layer: u8,
    },
    PixelFadeSet {
        state: CapabilityEvent,
        profile: u8,
        config: u8,
        period: u8,
    },
    PixelGammaControl {
        state: CapabilityEvent,
        mode: GammaControl,
    },
    PixelLedControl {
        state: CapabilityEvent,
        mode: LedControl,
        amount: u8,
    },
    PixelTest {
        state: CapabilityEvent,
        test: PixelTest,
        index: u16,
    },
    Analog {
        state: CapabilityEvent,
    },
    HidioOpenUrl {
        state: CapabilityEvent,
        index: u16,
    },
    HidioUnicodeString {
        state: CapabilityEvent,
        index: u16,
    },
    HidioUnicodeState {
        state: CapabilityEvent,
        unicode: char,
    },
}

CapabilityRun Used to run capabilities rather than map them out in a result guide

Variants

NoOp

No-op / None action 4 bytes

Fields

state: CapabilityEvent

Rotate

Rotation event trigger 6 bytes

Fields

state: CapabilityEvent

index: u8

increment: i8

LayerClear

Clears all layer states NOTE: Does not send trigger events 4 bytes

Fields

state: CapabilityEvent

LayerState

Updates layer to the specified state 6 bytes

Fields

state: CapabilityEvent

layer: u8

layer_state: State

LayerRotate

Rotates through possible layers given the direction Uses internal state to keep track of the current layer 5 bytes

Fields

state: CapabilityEvent

direction: Direction

HidProtocol

HID Protocol Mode 5 bytes

Fields

state: CapabilityEvent

mode: Protocol

HidKeyboard

USB HID keyboard event Handles press/released based on incoming state 5 bytes

Fields

state: CapabilityEvent

id: Keyboard

HidKeyboardState

USB HID keyboard event Force state event 6 bytes

Fields

state: CapabilityEvent

id: Keyboard

key_state: State

HidConsumerControl

USB HID Consumer Control Event Handles press/released based on incoming state 6 bytes

Fields

state: CapabilityEvent

id: ConsumerControl

HidSystemControl

USB HID System Control Event Handles press/released based on incoming state 5 bytes

Fields

state: CapabilityEvent

id: SystemControl

McuFlashMode

Enter Flash Mode Usually jumps to the bootloader 4 bytes

Fields

state: CapabilityEvent

HidLed

USB HID Led event Handles press/released based on incoming state 5 bytes

Fields

state: CapabilityEvent

id: LedIndicator

PixelAnimationControl

Overall animation control 5 bytes

Fields

state: CapabilityEvent

mode: AnimationControl

PixelAnimationIndex

Activates the given indexed Animation 6 bytes

Fields

state: CapabilityEvent

index: u16

PixelFadeControl

Fade control 7 bytes

Fields

state: CapabilityEvent

profile: u8

command: FadeCommand

arg: u8

PixelFadeLayer

Layer fade 5 bytes

Fields

state: CapabilityEvent

layer: u8

PixelFadeSet

Fade set profile 7 bytes

Fields

state: CapabilityEvent

profile: u8

config: u8

period: u8

PixelGammaControl

Enable/Disable/Toggle gamma correction 5 bytes

Fields

state: CapabilityEvent

mode: GammaControl

PixelLedControl

LED Control 6 bytes

Fields

state: CapabilityEvent

mode: LedControl

amount: u8

PixelTest

Pixel test 7 bytes

Fields

state: CapabilityEvent

test: PixelTest

index: u16

Analog

Analog Event Always a passthrough event 4 bytes

Fields

state: CapabilityEvent

HidioOpenUrl

Sends URL (using index stored unicode string) to host computer web browser 6 bytes

Fields

state: CapabilityEvent

index: u16

HidioUnicodeString

Sends Unicode string (using index stored unicode string) to host computer 6 bytes

Fields

state: CapabilityEvent

index: u16

HidioUnicodeState

Sends Unicode character with state (Press or Release) 8 bytes

Fields

state: CapabilityEvent

unicode: char

Implementations

impl CapabilityRun

pub fn state(&self) -> CapabilityEvent

Trait Implementations

impl Clone for CapabilityRun

fn clone(&self) -> CapabilityRun

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CapabilityRun

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

Formats the value using the given formatter.

impl From<Capability> for CapabilityRun

Convert Capability to CapabilityRun Used for mainly for kll validation

fn from(cap: Capability) -> Self

Converts to this type from the input type.

impl From<TriggerEvent> for CapabilityRun

fn from(event: TriggerEvent) -> Self

Converts to this type from the input type.

impl Hash for CapabilityRun

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 PartialEq for CapabilityRun

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

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

const 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 Copy for CapabilityRun

impl Eq for CapabilityRun

impl StructuralPartialEq for CapabilityRun