Struct InputRouter 

pub struct InputRouter<A: Clone> { /* private fields */ }

Routes key events through captured, focused, and global keymaps.

Resolution order is:

1. Captured scopes, newest first.
2. Bindings for the current focused component.
3. Global bindings.

Exclusive captures stop routing when they do not handle a key, which is useful for blocking modals. Passthrough captures let unhandled keys continue to older layers, which is useful for temporary modes or non-blocking overlays.

Implementations

impl<A: Clone> InputRouter<A>

pub fn new() -> Self

Create an empty input router.

pub fn bind_global(self, key: KeyBinding, action: A, description: &str) -> Self

Add a global binding and return the router.

pub fn bind_focus( self, id: FocusId, key: KeyBinding, action: A, description: &str, ) -> Self

Add a focused component binding and return the router.

pub fn bind_scope<S>( self, scope: S, key: KeyBinding, action: A, description: &str, ) -> Self

where S: Into<InputScope>,

Add a named or focus-scope binding and return the router.

pub fn register_global(&mut self, key: KeyBinding, action: A, description: &str)

Register a global binding.

pub fn register_focus( &mut self, id: FocusId, key: KeyBinding, action: A, description: &str, )

Register a binding for a focusable component.

pub fn register_scope<S>( &mut self, scope: S, key: KeyBinding, action: A, description: &str, )

where S: Into<InputScope>,

Register a binding for a named or focus scope.

pub fn push_capture<S>(&mut self, scope: S)

where S: Into<InputScope>,

Push an exclusive capture for a scope.

pub fn push_capture_with_mode<S>(&mut self, scope: S, mode: InputCaptureMode)

where S: Into<InputScope>,

Push a capture with explicit unhandled-key behavior.

pub fn pop_capture(&mut self) -> Option<InputCapture>

Remove the newest capture and return it.

pub fn remove_capture<S>(&mut self, scope: S) -> bool

where S: Into<InputScope>,

Remove the newest capture for a scope.

pub fn clear_captures(&mut self)

Remove all active captures.

pub fn active_capture(&self) -> Option<&InputCapture>

Return the currently active capture, if any.

pub fn resolve_key( &self, key: &KeyEvent, focused: Option<FocusId>, ) -> Option<RoutedInput<A>>

Resolve a key event against the current captures, focus, and globals.

pub fn resolve_event( &self, event: &Event, focused: Option<FocusId>, ) -> Option<RoutedInput<A>>

Resolve a terminal event. Non-key events are ignored.

pub fn global_help(&self) -> Vec<(String, String)>

Help entries for global bindings.

pub fn focus_help(&self, id: FocusId) -> Vec<(String, String)>

Help entries for a focusable component.

pub fn scope_help<S>(&self, scope: S) -> Vec<(String, String)>

where S: Into<InputScope>,

Help entries for a named or focus scope.

pub fn active_help(&self, focused: Option<FocusId>) -> Vec<InputHelpEntry>

Help entries in the same order that key routing would consider them.

Trait Implementations

impl<A: Clone> Default for InputRouter<A>

fn default() -> Self

Returns the “default value” for a type.