Enum TextObject 

pub enum TextObject {
    InnerWord(WordBoundary),
    AWord(WordBoundary),
    InnerParagraph,
    AParagraph,
    InnerQuote(char),
    AQuote(char),
    InnerBracket(char),
    ABracket(char),
}

Text object types for operator-pending mode.

Text objects define regions of text that operators act upon. Each text object has inner (i) and around (a) variants.

Example

use reovim_kernel::api::v1::*;

// Delete inner word: diw
let inner_word = TextObject::InnerWord(WordBoundary::Word);

// Yank around parentheses: ya(
let around_paren = TextObject::ABracket('(');

Variants

InnerWord(WordBoundary)

Inner word (iw, iW)

AWord(WordBoundary)

A word including surrounding whitespace (aw, aW)

InnerParagraph

Inner paragraph (ip)

AParagraph

A paragraph including surrounding blank lines (ap)

InnerQuote(char)

Inner quotes (i“, i’, i`)

AQuote(char)

Around quotes including the quote characters (a“, a’, a`)

InnerBracket(char)

Inner bracket (i(, i[, i{, i<)

ABracket(char)

Around bracket including the brackets (a(, a[, a{, a<)

Implementations

impl TextObject

pub const fn is_inner(&self) -> bool

Check if this text object is an “inner” variant.

pub const fn is_around(&self) -> bool

Check if this text object is an “around” variant.

pub const fn from_chars(scope: char, object: char) -> Option<Self>

Parse a text object from scope character and object character.

Arguments

• scope - ‘i’ for inner, ‘a’ for around
• object - The object character (w, W, (, [, {, “, ’, etc.)

Returns

Some(TextObject) if valid, None otherwise.

Trait Implementations

impl Clone for TextObject

fn clone(&self) -> TextObject

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TextObject

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

Formats the value using the given formatter.

impl PartialEq for TextObject

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for TextObject

impl Eq for TextObject

impl StructuralPartialEq for TextObject