Skip to main content

InsertEscapeSequence

Struct InsertEscapeSequence 

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

Configures the character sequence that leaves Insert mode.

Default is jj. A prefix is inserted into the buffer immediately and remembered only as a possible escape, so a lone j, a mismatch, context switch, or caller that never supplies another input cannot lose text. When the complete sequence arrives, its already-inserted prefix is removed and the buffer follows the same cursor-normalization contract as EditorInput::Escape.

Use Self::disabled to permit literal jj, or Self::new to replace the default with another sequence such as jk.

use vim_navigation::InsertEscapeSequence;

assert_eq!(InsertEscapeSequence::default().as_str(), Some("jj"));
assert_eq!(InsertEscapeSequence::new("jk")?.as_str(), Some("jk"));
assert_eq!(InsertEscapeSequence::disabled().as_str(), None);

Implementations§

Source§

impl InsertEscapeSequence

Source

pub fn new(sequence: &str) -> Result<Self, InsertEscapeSequenceError>

Creates a non-empty escape sequence containing no line separators.

The sequence is matched as Unicode scalar values in insertion order. Use Self::disabled instead of an empty string.

§Errors

Returns InsertEscapeSequenceError for an empty sequence or one containing \n or \r.

Source

pub const fn disabled() -> Self

Disables Insert-mode character escape recognition.

With this setting, jj and every other character sequence are inserted literally; EditorInput::Escape remains available.

Source

pub fn as_str(&self) -> Option<&str>

Returns the configured sequence, or None when recognition is disabled.

Trait Implementations§

Source§

impl Clone for InsertEscapeSequence

Source§

fn clone(&self) -> Self

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 Debug for InsertEscapeSequence

Source§

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

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

impl Default for InsertEscapeSequence

Source§

fn default() -> Self

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

impl Eq for InsertEscapeSequence

Source§

impl PartialEq for InsertEscapeSequence

Source§

fn eq(&self, other: &Self) -> 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 InsertEscapeSequence

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, 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 = !

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

fn try_from(value: U) -> Result<T, !>

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.