Struct undo::record::Checkpoint

pub struct Checkpoint<'a, A, F> { /* fields omitted */ }

Wraps a record and gives it checkpoint functionality.

Implementations

impl<A: Action<Output = ()>, F: FnMut(Signal)> Checkpoint<'_, A, F>

pub fn apply(&mut self, target: &mut A::Target, action: A) -> Result<A>

Calls the apply method.

pub fn undo(&mut self, target: &mut A::Target) -> Option<Result<A>>

Calls the undo method.

pub fn redo(&mut self, target: &mut A::Target) -> Option<Result<A>>

Calls the redo method.

pub fn commit(self)

Commits the changes and consumes the checkpoint.

pub fn cancel(self, target: &mut A::Target) -> Option<Result<A>>

Cancels the changes and consumes the checkpoint.

Errors

If an error occur when canceling the changes, the error is returned and the remaining actions are not canceled.

pub fn queue(&mut self) -> Queue<'_, A, F>

Returns a queue.

pub fn checkpoint(&mut self) -> Checkpoint<'_, A, F>

Returns a checkpoint.

Trait Implementations

impl<'a, A: Debug, F: Debug> Debug for Checkpoint<'a, A, F>

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

Formats the value using the given formatter.

impl<'a, A, F> From<&'a mut Record<A, F>> for Checkpoint<'a, A, F>

fn from(record: &'a mut Record<A, F>) -> Self

Performs the conversion.