Skip to main content

History

Struct History 

Source
pub struct History {
    current: EditProject,
    undo: Vec<EditProject>,
    redo: Vec<EditProject>,
    limit: usize,
}
Expand description

A bounded undo / redo stack wrapping a live EditProject.

Edits go through History::apply, which snapshots the project before each change. Because apply runs the operation on a clone and only commits when the project actually changed, apply then undo is guaranteed to restore the exact prior state — no fragile per-operation inverse derivation, and no-op operations never pollute the undo stack.

Fields§

§current: EditProject§undo: Vec<EditProject>§redo: Vec<EditProject>§limit: usize

Implementations§

Source§

impl History

Source

pub fn new(project: EditProject) -> Self

Wrap a project with an undo stack of the default depth.

Source

pub fn with_limit(project: EditProject, limit: usize) -> Self

Wrap a project with an undo stack of at most limit steps (clamped to at least 1).

Source

pub fn project(&self) -> &EditProject

The live project.

Source

pub fn can_undo(&self) -> bool

Whether there is anything to undo.

Source

pub fn can_redo(&self) -> bool

Whether there is anything to redo.

Source

pub fn apply(&mut self, op: &EditOp) -> Result<(), EditError>

Apply an edit, recording it for undo if it changed anything.

§Errors

Propagates EditError from EditProject::apply. On error the project is left unchanged (the operation runs on a clone that is discarded).

Source

pub fn undo(&mut self) -> bool

Undo the last recorded change. Returns whether anything was undone (the boolean is an optional signal — undo is usually called for effect).

Source

pub fn redo(&mut self) -> bool

Redo the last undone change. Returns whether anything was redone.

Trait Implementations§

Source§

impl Clone for History

Source§

fn clone(&self) -> History

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for History

Source§

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

Formats the value using the given formatter. 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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.