Skip to main content

History

Struct History 

Source
pub struct History { /* private fields */ }
Expand description

Undo/redo history using invertible transactions.

Consecutive single-character edits are coalesced into groups so that undoing “typed a word” undoes the whole word, not one char at a time.

Implementations§

Source§

impl History

Source

pub fn new() -> Self

Source

pub fn push(&mut self, tx: Transaction)

Record a transaction. Clears the redo stack. Tries to coalesce with the most recent undo entry.

Source

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

Pop the most recent transaction for undo. Returns its inverse (which should be applied to revert the change).

Source

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

Pop the most recent redo transaction. Returns it (which should be re-applied).

Source

pub fn mark_clean(&mut self)

Mark the current state as clean (e.g., after save). Also forces the next edit into a new undo group so that undoing back to this point is always possible.

Source

pub fn is_dirty(&self) -> bool

Check if the document is dirty (modified since last save).

Source

pub fn can_undo(&self) -> bool

True if there are entries to undo.

Source

pub fn can_redo(&self) -> bool

True if there are entries to redo.

Source

pub fn clear(&mut self)

Clear all history and reset to clean state.

Trait Implementations§

Source§

impl Debug for History

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for History

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.