Struct EditOutcome 

pub struct EditOutcome {
    pub changed: bool,
    pub bulk: bool,
    pub damage: Option<Range<usize>>,
    pub line_delta: isize,
}

What one call to RopeBuffer::edit did, measured rather than predicted.

#[must_use] on purpose: the caller still applies these (the revision clock serves both backends and so stays on the component), and forgetting to is exactly the failure this type exists to prevent. A warning is a check; a convention is not.

Fields

changed: bool

The buffer’s text differs from before the edit. A content comparison — never a library return value, which can report false after mutating.

bulk: bool

The change is not confined to the cursor’s row, so the incremental parser’s cursor damage hint would under-report it.

damage: Option<Range<usize>>

Which rows the edits changed, in the new text’s numbering — the hull when several ran before this was drained.

Told by the engine rather than found by comparing the buffer with a copy of its previous self, which is what the revision-tagged rope makes possible. The nvim backend reports lines and not changes, so it leaves this None and its consumer falls back to a diff.

line_delta: isize

Net rows added (or removed, when negative) by the edits behind damage.

Travels with the range because the range is only meaningful in a numbering, and a consumer that accumulates reports across several drains has to bring the older one forward before it can union them.

Trait Implementations

impl Clone for EditOutcome

fn clone(&self) -> EditOutcome

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EditOutcome

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

Formats the value using the given formatter.

impl Default for EditOutcome

fn default() -> EditOutcome

Returns the “default value” for a type.

impl Eq for EditOutcome

impl PartialEq for EditOutcome

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for EditOutcome