Enum Motion 

pub enum Motion {
    Left,
    Right,
    Up,
    Down,
    WordStartNext,
    WordEndNext,
    WordStartPrev,
    LineStart,
    LineFirstNonBlank,
    LineEnd,
    DocStart,
    DocEnd,
    PageUp,
    PageDown,
    HalfPageUp,
    HalfPageDown,
    GotoLine(u32),
    ForwardSexp,
    BackwardSexp,
    UpList,
    DownList,
    BeginningOfDefun,
    EndOfDefun,
    BeginningOfSexp,
    EndOfSexp,
    SearchNext,
    SearchPrev,
}

Cursor motions — primitive movements the keymap compiles user keys to.

Two families:

• Text motions — vim-ish char/word/line/doc/page motions.
• Structural motions — Lisp-aware (forward-sexp) / (backward-sexp) / (up-list) / (down-list) equivalents. Enabled on buffers whose major mode opts in via (defmajor-mode … :structural-lisp #t). Matches paredit’s model — equal-or-superior to emacs on Lisp UX.

Variants

Left

Right

Up

Down

WordStartNext

WordEndNext

WordStartPrev

LineStart

LineFirstNonBlank

LineEnd

DocStart

DocEnd

PageUp

PageDown

HalfPageUp

HalfPageDown

GotoLine(u32)

ForwardSexp

Move to the start of the next sibling s-expression.

BackwardSexp

Move to the start of the previous sibling s-expression.

UpList

Move up one parenthesis level — to the opening ( of the enclosing list.

DownList

Move down into the current list — past the opening (.

BeginningOfDefun

Move to the start of the enclosing top-level defun / top form.

EndOfDefun

Move to the end of the enclosing top-level defun / top form.

BeginningOfSexp

Move to the start of the current s-expression (current atom / list open).

EndOfSexp

Move to the end of the current s-expression (matching close).

SearchNext

To the next search match — vim’s n used as a MOTION, which is what makes d/foo<CR>, dn and y* work. Search being a motion rather than a bare cursor jump is the difference between a search box and vim search; resolving it needs the committed SearchState, so the executor supplies it — the enum stays a pure description, like every other arm.

SearchPrev

To the previous search match (vim’s N as a motion).

Implementations

impl Motion

pub const fn is_inclusive(self) -> bool

Does this motion name a character to ACT ON, rather than a boundary to stop before?

vim’s exclusive/inclusive split, and it is not cosmetic: dw deletes up to the next word and de deletes through the current one. An operator range is [cursor, target), so an inclusive motion’s target has to be widened by one character or the operator leaves the last character behind — off by exactly one, on the key most likely to be used to delete a word without its trailing space.

WordEndNext is the only inclusive motion escriba has today. f/t/ % are the others in vim and are not bound yet; each lands here when it does, which is the point of asking the MOTION rather than special-casing e at the operator.

pub const fn is_structural(self) -> bool

Trait Implementations

impl Clone for Motion

fn clone(&self) -> Motion

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Motion

impl Debug for Motion

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Motion

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Motion

impl Hash for Motion

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl JsonSchema for Motion

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq for Motion

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Motion

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Motion