Struct DefaultKeyHandler 

pub struct DefaultKeyHandler { /* private fields */ }

Default key handler with configurable bindings.

This implementation uses KeyBindings to determine what actions to take for each key press. It handles the standard key processing flow while allowing customization of all bindings.

The handler manages exit confirmation state internally, so agents get the two-key exit flow (e.g., press Ctrl+D twice) without needing to track any state in the App.

Custom Bindings

In addition to the standard bindings, you can add custom key bindings that trigger custom actions:

let handler = DefaultKeyHandler::new(KeyBindings::emacs())
    .with_custom_binding(KeyCombo::ctrl('t'), || {
        AppKeyAction::custom(MyCustomAction::ToggleSomething)
    });

Implementations

impl DefaultKeyHandler

pub fn new(bindings: KeyBindings) -> Self

Create a new handler with the given bindings.

pub fn bindings(&self) -> &KeyBindings

Get a reference to the key bindings.

pub fn with_custom_binding<F>(self, combo: KeyCombo, action_fn: F) -> Self

where F: Fn() -> AppKeyAction + Send + Sync + 'static,

Add a custom key binding that triggers a custom action.

Custom bindings are checked before standard bindings, allowing you to override default behavior or add new key combinations.

Arguments

• combo - The key combination to bind
• action_fn - A function that returns the action to execute

Example

let handler = DefaultKeyHandler::new(KeyBindings::emacs())
    .with_custom_binding(KeyCombo::ctrl('t'), || {
        AppKeyAction::custom(MyCustomAction::ToggleSomething)
    })
    .with_custom_binding(KeyCombo::alt('h'), || {
        AppKeyAction::custom(MyCustomAction::ShowHelp)
    });

Trait Implementations

impl Default for DefaultKeyHandler

fn default() -> Self

Returns the “default value” for a type.

impl KeyHandler for DefaultKeyHandler

fn handle_key(&mut self, key: KeyEvent, context: &KeyContext) -> AppKeyResult

Handle a key event.

fn status_hint(&self) -> Option<String>

Get a status hint to display in the status bar.

fn bindings(&self) -> &KeyBindings

Get a reference to the key bindings.