Skip to main content

KeyTableStack

Struct KeyTableStack 

Source
pub struct KeyTableStack { /* private fields */ }
Expand description

A stack of active key tables

Implementations§

Source§

impl KeyTableStack

Source

pub fn new(default_table: KeyTable) -> Self

Create a new key table stack with a default table

Source

pub fn push(&mut self, activation: KeyTableActivation)

Push a new key table activation onto the stack

Source

pub fn pop(&mut self) -> Option<KeyTableActivation>

Pop the top key table from the stack

Source

pub fn current(&self) -> Option<&KeyTableActivation>

Get the current (top) key table activation

Source

pub fn current_name(&self) -> &str

Get the name of the current key table, or “default” if stack is empty

Source

pub fn clear(&mut self)

Clear the entire stack

Source

pub fn is_empty(&self) -> bool

Check if the stack is empty

Source

pub fn len(&self) -> usize

Get the number of tables on the stack (not including default)

Source

pub fn resolve(&self, combo: &KeyCombo) -> Option<&KeyAction>

Resolve a key combination by searching the stack from top to bottom

Returns the action if found, None otherwise

Source

pub fn handle_key(&mut self, combo: KeyCombo, now: Instant) -> Option<KeyAction>

Handle a key press, resolving it and managing one-shot/timeout behavior

Returns the action if found, None otherwise

Source

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

Check if any tables have timeouts and return the earliest timeout

Source

pub fn default_table(&self) -> &KeyTable

Get a reference to the default table

Source

pub fn default_table_mut(&mut self) -> &mut KeyTable

Get a mutable reference to the default table

Trait Implementations§

Source§

impl Clone for KeyTableStack

Source§

fn clone(&self) -> KeyTableStack

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for KeyTableStack

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for KeyTableStack

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> ArchivePointee for T

Source§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
Source§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<F, W, T, D> Deserialize<With<T, W>, D> for F
where W: DeserializeWith<F, T, D>, D: Fallible + ?Sized, F: ?Sized,

Source§

fn deserialize( &self, deserializer: &mut D, ) -> Result<With<T, W>, <D as Fallible>::Error>

Deserializes using the given deserializer
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> LayoutRaw for T

Source§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Gets the layout of the type.
Source§

impl<T> Pointee for T

Source§

type Metadata = ()

The type for metadata in pointers and references to Self.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V