Skip to main content

BindingMode

Enum BindingMode 

Source
pub enum BindingMode {
Show 24 variants Normal, Insert, Visual, Select, Replace, Command, Search, Prompt, OperatorPending, AfterG, AfterZ, AfterMark, AfterJumpMarkLine, AfterJumpMarkExact, AfterRegister, AfterMacroStart, AfterMacroPlay, AfterFindChar, AfterTextObject, Help, AfterCtrlW, AfterCtrlX, CompletionPopup, Snippet,
}
Expand description

Where a binding takes effect. Multi-key sequences (e.g. gg) resolve atomically; intermediate single-key prefixes (g, z) get their own descriptor entries so :describe-key g explains the pending substate.

Variants§

§

Normal

Vim Normal mode — the default command state.

§

Insert

Insert mode: unbound printable chords insert themselves as text.

§

Visual

Charwise / Linewise / Blockwise visual share the same chord table; differences are in the operator dispatch (Range::Selection resolution).

§

Select

Vim Select mode (SN.3d). Its own chord table — distinct from Self::Visual because a bare printable key dispatches differently (Visual: command lookup; Select: replace-and-insert). Motions/extensions are duplicated from the Visual table and kept honest by a parity test. See docs/dev/architecture/select-mode.md.

§

Replace

Vim Replace mode (R): typed chars overwrite rather than insert.

§

Command

: minibuffer.

§

Search

/ ? minibuffer.

§

Prompt

Effect::OpenPrompt’s generic one-line prompt — the third buffer-backed readline surface, peer of Self::Command and Self::Search.

Its own table for the same reason they have theirs: a minibuffer is not an Insert buffer. Resolving these surfaces against the Insert table let every globally-active minor’s Insert bindings leak onto them — auto-pair’s <BS> shadowed the builtin backspace on the : line, so backspace did nothing there in either renderer.

§

OperatorPending

After d / y / c / > / < / gU / gu / g~ – waiting for a motion or text-object target.

§

AfterG

After g – waiting for the second key.

§

AfterZ

After z – waiting for the second key.

§

AfterMark

After m – waiting for the mark name.

§

AfterJumpMarkLine

After ' (jump to mark line) – waiting for mark name.

§

AfterJumpMarkExact

After ` (jump to mark exact) – waiting for mark name.

§

AfterRegister

After " – waiting for register name.

§

AfterMacroStart

After q (when not already recording) – waiting for register name to record into.

§

AfterMacroPlay

After @ – waiting for register name to play (or @ for last).

§

AfterFindChar

After f / F / t / T – waiting for the target char.

§

AfterTextObject

After i<x> / a<x> in operator-pending – waiting for the text-object key.

§

Help

While the §5.11 help overlay is active.

§

AfterCtrlW

After <C-w> – waiting for the window-management resolution key.

§

AfterCtrlX

After <C-x> in Insert mode – waiting for the expansion-prefix resolution key (<C-x><C-o> -> completion trigger; future siblings: <C-x><C-s> snippet expand, <C-x><C-f> filename completion).

§

CompletionPopup

Insert-mode completion popup minor mode (Phase 4.2.g.1). Active only while App.insert_completion.is_some(). Bindings inside this layer override Insert-mode + Normal-mode meanings for the popup’s lifetime; closing the popup deactivates the layer.

§

Snippet

Active-snippet minor mode (Phase 4.2.g.4). Active only while App.active_snippet.is_some(). Bindings inside this layer override Insert-mode meanings for the snippet’s lifetime: <Tab> jumps to the next placeholder (instead of inserting a literal tab), <S-Tab> to the previous, <Esc> exits the snippet and Insert mode. Closing the snippet (reaching $0, pressing <Esc>, or :snippet-leave) deactivates the layer.

Implementations§

Source§

impl BindingMode

Source

pub fn label(self) -> &'static str

Human-readable label used in :describe-key output and diagnostics. Also the Display form.

§Examples
use lattice_keymap::BindingMode;

assert_eq!(BindingMode::OperatorPending.label(), "Operator-Pending");
assert_eq!(BindingMode::AfterG.to_string(), "After-g");
Source

pub fn all() -> &'static [BindingMode]

The binding modes :describe-key iterates, in declaration order. Used by KeymapHandle::resolve_trace_all_modes to walk every mode.

Note: the list currently omits Self::Prompt (23 of the 24 variants), so a chord bound only in the Prompt table is not reported by the all-modes trace.

§Examples
use lattice_keymap::BindingMode;

assert_eq!(BindingMode::all()[0], BindingMode::Normal);
assert!(BindingMode::all().contains(&BindingMode::Snippet));

Trait Implementations§

Source§

impl Clone for BindingMode

Source§

fn clone(&self) -> BindingMode

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for BindingMode

Source§

impl Debug for BindingMode

Source§

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

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

impl Display for BindingMode

Source§

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

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

impl Eq for BindingMode

Source§

impl Hash for BindingMode

Source§

fn hash<__H>(&self, state: &mut __H)
where __H: Hasher,

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for BindingMode

Source§

fn eq(&self, other: &BindingMode) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for BindingMode

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
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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
§

impl<T> Downcast for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync> ⓘ

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

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

Source§

fn __clone_box(&self, _: Private) -> *mut ()

§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> IntoMaybeUndefined<T> for T

§

fn into_maybe_undefined(self) -> MaybeUndefined<T>

Converts this value into a three-state builder argument.
§

impl<T> IntoOption<T> for T

§

fn into_option(self) -> Option<T>

Converts this value into an optional builder argument.
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> Pointee for T

§

type Pointer = u32

§

fn debug( pointer: <T as Pointee>::Pointer, f: &mut Formatter<'_>, ) -> Result<(), Error>

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

§

impl<T> ResetDiscriminant<T> for T
where T: Copy,

§

fn discriminant(&self) -> T

Value based on which equality for the reset will be determined.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<T> ToCompactString for T
where T: Display,

§

fn try_to_compact_string(&self) -> Result<CompactString, ToCompactStringError>

Fallible version of [ToCompactString::to_compact_string()] Read more
§

fn to_compact_string(&self) -> CompactString

Converts the given value to a [CompactString]. Read more
§

impl<T> ToLine for T
where T: Display,

§

fn to_line(&self) -> Line<'_>

Converts the value to a [Line].
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
§

impl<T> ToSpan for T
where T: Display,

§

fn to_span(&self) -> Span<'_>

Converts the value to a [Span].
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
§

impl<T> ToText for T
where T: Display,

§

fn to_text(&self) -> Text<'_>

Converts the value to a [Text].
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.
§

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

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

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