Struct Layer 

pub struct Layer { /* private fields */ }

A named collection of bindings that can be activated and deactivated.

Construct via the builder pattern, then register with Dispatcher::define_layer.

Examples

Basic layer with vim-style navigation:

use kbd::action::Action;
use kbd::key::Key;
use kbd::layer::Layer;

let nav = Layer::new("nav")
    .bind(Key::H, Action::Suppress)
    .bind(Key::J, Action::Suppress)
    .bind(Key::K, Action::Suppress)
    .bind(Key::L, Action::Suppress)
    .description("Vim navigation keys")
    .swallow();

assert_eq!(nav.name().as_str(), "nav");
assert_eq!(nav.binding_count(), 4);

Oneshot layer that auto-pops after one keypress:

use kbd::action::Action;
use kbd::key::Key;
use kbd::layer::Layer;

let leader = Layer::new("leader")
    .bind(Key::F, Action::Suppress)
    .bind(Key::B, Action::Suppress)
    .oneshot(1);

Layer with a timeout that auto-pops after inactivity:

use std::time::Duration;
use kbd::action::Action;
use kbd::key::Key;
use kbd::layer::Layer;

let timed = Layer::new("quick-nav")
    .bind(Key::N, Action::Suppress)
    .bind(Key::P, Action::Suppress)
    .timeout(Duration::from_secs(2));

Implementations

impl Layer

pub fn new(name: impl Into<LayerName>) -> Self

Create a new layer with the given name.

pub fn bind(self, hotkey: impl Into<Hotkey>, action: impl Into<Action>) -> Self

Add a binding to this layer.

pub fn swallow(self) -> Self

Set the layer to swallow unmatched keys (consume instead of fallthrough).

pub fn oneshot(self, depth: usize) -> Self

Set the layer to auto-pop after depth keypresses (oneshot mode).

pub fn timeout(self, duration: Duration) -> Self

Set the layer to auto-pop after duration of inactivity.

pub fn description(self, description: impl Into<Box<str>>) -> Self

Set a human-readable description for this layer.

Used for overlay grouping and help screen display.

pub fn name(&self) -> &LayerName

The layer’s name.

pub fn options(&self) -> &LayerOptions

The layer’s options.

pub fn binding_count(&self) -> usize

The number of bindings in this layer.

Trait Implementations

impl Debug for Layer

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

Formats the value using the given formatter.