Struct LeaderKeyState 

pub struct LeaderKeyState {
    pub key: KeyCombo,
    /* private fields */
}

State of the leader key

Fields

key: KeyCombo

The key combination that activates the leader

Implementations

impl LeaderKeyState

pub fn new(key: KeyCombo, timeout_ms: u64) -> Self

Create a new leader key state

pub fn with_sequence(sequence: Vec<KeyCombo>, timeout_ms: u64) -> Self

Create a leader key state with a multi-key prefix sequence

pub fn is_active(&self) -> bool

Check if the leader is currently active

pub fn timeout(&self) -> Duration

Get the timeout duration

pub fn activate(&mut self)

Activate the leader key

pub fn deactivate(&mut self)

Deactivate the leader key

pub fn reset(&mut self)

Reset the leader state (same as deactivate)

pub fn feed_key(&mut self, combo: &KeyCombo) -> bool

Feed a key to the leader state machine

Returns true if the leader should be activated

pub fn check_timeout(&mut self) -> bool

Check if the leader has timed out

Returns true if timeout occurred, false otherwise

pub fn time_remaining(&self) -> Option<Duration>

Get the time remaining before timeout (if active)

pub fn timeout_at(&self) -> Option<Instant>

Get when the leader will timeout (if active)

pub fn is_sequence_in_progress(&self) -> bool

Check if the sequence is in progress (for multi-key leaders)

pub fn sequence_progress(&self) -> &[KeyCombo]

Get the current sequence progress

pub fn update_config(&mut self, key: KeyCombo, timeout_ms: u64)

Update the leader key configuration

Trait Implementations

impl Clone for LeaderKeyState

fn clone(&self) -> LeaderKeyState

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for LeaderKeyState

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

Formats the value using the given formatter.

impl From<LeaderKeyConfig> for LeaderKeyState

fn from(config: LeaderKeyConfig) -> Self

Converts to this type from the input type.