Struct History 

pub struct History { /* private fields */ }

The linear undo log.

ARCHITECTURE.md §8 wants one undo path for all sources; a linear stack delivers that. Helix’s undo tree is strictly more powerful, and is additive on top of this log if V1 ever needs it — the log is the hard part and we are building it either way.

Implementations

impl History

pub fn new() -> Self

pub fn group_for(&mut self, source: &EditSource) -> UndoGroupId

The undo group a new edit from source belongs to.

Consecutive typing merges; anything else starts a fresh group, as does an explicit break_group from a cursor move or a save.

pub fn break_group(&mut self)

End the current undo group, so the next edit starts a new one.

Called on a cursor move, a save, or an idle timeout — the boundaries a user intuitively expects undo to stop at.

pub fn push(&mut self, transaction: &EditTransaction, inverse: ChangeSet)

Record a transaction that has just been applied, with the inverse computed against the document as it was before the change.

pub fn can_undo(&self) -> bool

pub fn can_redo(&self) -> bool

pub fn undo(&mut self) -> Option<ChangeSet>

The change that undoes the most recent group, or None at the start of history.

The whole group comes back as one changeset, so a run of typing — or an accepted multi-hunk proposal — is one keystroke to reverse.

pub fn redo(&mut self) -> Option<ChangeSet>

The change that reapplies the most recently undone group.

Trait Implementations

impl Debug for History

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

Formats the value using the given formatter.

impl Default for History

fn default() -> History

Returns the “default value” for a type.