Struct keytokey::handlers::Layer

pub struct Layer<'a> { /* fields omitted */ }

A layer either rewrites a key to another one or outputs a string upon key release.

It does this for multiple mappings at once, and it can consider the shift state, which is very useful for unicode characters with lower and upper case.

Unfortunatly, Layers are memory inefficient, they keep their mapping in ram, and each mapping is at least 96 bits / 12 bytes.

Consider using a RewriteLayer instead if you don't need the string, Shift or Action functionality.

If AutoOff is set to anything but AutoOff::No, the layer will turn itself of after any key release (AutoOff::AfterAll), after a non-modifier-non-oneshot key release (AutoOff::AfterNonModifier), or after a successfull match AutoOff::AfterMatch

Implementations

impl<'_> Layer<'_>

pub fn new<F: AcceptsKeycode>(
    rewrites: Vec<(F, LayerAction)>,
    auto_off: AutoOff
) -> Layer

Trait Implementations

impl<'_, T: USBKeyOut> ProcessKeys<T> for Layer<'_>

fn process_keys(
    &mut self,
    events: &mut Vec<(Event, EventStatus)>,
    output: &mut T
) -> HandlerResult

fn default_enabled(&self) -> bool

whether this handler is enabled after add_handlers (true for most, false for Layers)