Struct NearbyWord 

pub struct NearbyWord {
    pub word: String,
    pub byte_start: usize,
    pub byte_end: usize,
    pub caret_offset_chars: i32,
}

A word the buffer holds near (but not necessarily at) the caret, with the offset metadata needed to navigate there and replace it. Returned by Buffer::words_near_caret; the corrector uses these to recover when the buffer caret has drifted a few chars from the visible cursor (held auto-repeat, mouse click, etc.) and the picked word_at_caret turns out to be fine.

Fields

word: String

The word itself.

byte_start: usize

Byte position of the word’s START in the buffer’s text.

byte_end: usize

Byte position one past the word’s END in the buffer’s text.

caret_offset_chars: i32

Signed chars from the buffer caret to the END of this word (byte_end). Positive when the word ends to the RIGHT of the caret, negative to the LEFT, zero when the caret sits exactly at the word’s end. Emit uses this to compute Right/Left arrows before deleting the word.

Trait Implementations

impl Clone for NearbyWord

fn clone(&self) -> NearbyWord

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NearbyWord

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

Formats the value using the given formatter.

impl PartialEq for NearbyWord

fn eq(&self, other: &NearbyWord) -> 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 Eq for NearbyWord

impl StructuralPartialEq for NearbyWord