Struct SequenceDetector 

pub struct SequenceDetector { /* private fields */ }

Stateful detector for multi-key sequences (currently Esc Esc).

This detector transforms a stream of KeyEvents into SequenceOutputs, detecting Esc Esc sequences with configurable timeout handling.

Usage

Call feed for each key event. The detector returns:

• Pending: First Esc received, waiting for more input or timeout.
• Esc: Single Esc was detected (after timeout or other key).
• EscEsc: Double Esc sequence was detected.
• PassThrough: Key is not Esc, pass through to normal handling.

Call check_timeout periodically (e.g., on tick) to emit pending single Esc after timeout expires.

Implementations

impl SequenceDetector

pub fn new(config: SequenceConfig) -> Self

Create a new sequence detector with the given configuration.

pub fn with_defaults() -> Self

Create a new sequence detector with default configuration.

pub fn feed(&mut self, event: &KeyEvent, now: Instant) -> SequenceOutput

Process a key event and return the sequence output.

Only key press events are considered; repeat and release are ignored.

pub fn check_timeout(&mut self, now: Instant) -> Option<SequenceOutput>

Check for timeout and emit pending Esc if expired.

Call this periodically (e.g., on tick) to handle the case where the user pressed Esc once and is waiting.

Returns Some(SequenceOutput::Esc) if timeout expired, None otherwise.

pub fn is_pending(&self) -> bool

Whether the detector is waiting for a second Esc.

pub fn reset(&mut self)

Reset the detector to idle state.

Any pending Esc is discarded.

pub fn config(&self) -> &SequenceConfig

Get a reference to the current configuration.

pub fn set_config(&mut self, config: SequenceConfig)

Update the configuration.

Does not reset pending state.

Trait Implementations

impl Debug for SequenceDetector

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

Formats the value using the given formatter.