Enum TextObject 

pub enum TextObject {
    NextMatch,
    PrevMatch,
    Line,
    Word {
        around: bool,
    },
    Delimited {
        open: char,
        close: char,
        around: bool,
    },
}

A text EXTENT an operator can act over, as opposed to a point it moves to.

vim’s gn is the motivating case and shows why the distinction matters: dgn deletes the next match wherever it is, including when the cursor is nowhere near it. Modelled as a motion it would resolve to the match’s start and the operator would act over [cursor, match.start) — deleting the text BEFORE the match instead of the match. Same keys, opposite effect.

Closed, so an unhandled object cannot reach the executor.

Variants

NextMatch

gn — the next search match at or after the cursor.

PrevMatch

gN — the previous search match at or before the cursor.

Line

dd / cc / yy — the current line, LINEWISE.

A doubled operator in vim acts on whole lines, trailing newline included, which is why this is an object rather than a motion: there is no cursor-to-target range that expresses “this line and its terminator” without special-casing the last line.

Word

iw / aw — the word under the cursor.

around: true takes the trailing run of whitespace as well, which is the whole difference vim draws between diw and daw.

Fields

around: bool

Delimited

i( a{ i" … — the region between a matched pair.

One variant covers brackets and quotes because the only thing that differs is whether the delimiters nest; carrying open/close separately lets a quote say open == close instead of needing its own arm.

Fields

open: char

close: char

around: bool

Implementations

impl TextObject

pub const fn register_kind(self) -> RegisterKind

How an operator over this object leaves the register — and therefore how a later p replays it.

Total over TextObject, no wildcard arm. The mapping lives here, beside the variants, rather than at the one call site that needs it today: a new linewise object (vim’s ip/ap paragraph objects are the obvious next ones) must decide, and a wildcard would silently answer Charwise for them — the direction that pastes a paragraph into the middle of whatever line the cursor happens to be on.

Trait Implementations

impl Clone for TextObject

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for TextObject

impl Debug for TextObject

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TextObject

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for TextObject

impl Hash for TextObject

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 TextObject

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 TextObject

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for TextObject

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 TextObject