WhichKeyTrigger

Struct WhichKeyTrigger 

Source
pub struct WhichKeyTrigger {
    pub prefix: KeySequence,
}
Expand description

Command to trigger which-key with a specific prefix

This is used as an inline command for keybindings like g?, z?, etc. Each binding carries its own prefix so which-key knows what to filter.

Fields§

§prefix: KeySequence

Implementations§

Source§

impl WhichKeyTrigger

Source

pub const fn new(prefix: KeySequence) -> Self

Source

pub fn all() -> Self

Source

pub fn arc(prefix: KeySequence) -> Arc<dyn CommandTrait>

Create an Arc-wrapped command for use as inline command

Trait Implementations§

Source§

impl Clone for WhichKeyTrigger

Source§

fn clone(&self) -> WhichKeyTrigger

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 CommandTrait for WhichKeyTrigger

Source§

fn name(&self) -> &'static str

Unique identifier for this command (e.g., cursor_up, enter_insert_mode)
Source§

fn description(&self) -> &'static str

Human-readable description for help/documentation
Source§

fn execute(&self, _ctx: &mut ExecutionContext<'_>) -> CommandResult

Execute the command on the given buffer Read more
Source§

fn clone_box(&self) -> Box<dyn CommandTrait>

Clone into a boxed trait object Read more
Source§

fn as_any(&self) -> &dyn Any

Downcast support for type inspection
Source§

fn valid_modes(&self) -> Option<Vec<ModeState>>

Optional: which modes this command is valid in (None = all modes)
Source§

fn supports_count(&self) -> bool

Optional: does this command support repeat count?
Source§

fn is_jump(&self) -> bool

Whether this command is a “jump” that should be recorded in the jump list Read more
Source§

fn is_text_modifying(&self) -> bool

Whether this command modifies buffer text content Read more
Source§

fn resulting_mode(&self) -> Option<ModeState>

The mode to transition to after this command executes, if any Read more
Source§

impl Debug for WhichKeyTrigger

Source§

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

Formats the value using the given formatter. 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> 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<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> 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<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more