Struct redo::Checkpoint

pub struct Checkpoint<'a, T, C> { /* fields omitted */ }

A checkpoint wrapper.

Wraps a record or history and gives it checkpoint functionality. This allows the record or history to cancel all changes made since creating the checkpoint.

Examples

let mut record = Record::default();
let mut cp = record.checkpoint();
cp.apply(Add('a'))?;
cp.apply(Add('b'))?;
cp.apply(Add('c'))?;
assert_eq!(cp.as_target(), "abc");
cp.cancel()?;
assert_eq!(record.as_target(), "");

Methods

impl<'a, T, C> Checkpoint<'a, T, C>

pub fn new(inner: &'a mut T) -> Checkpoint<'a, T, C>

Returns a checkpoint.

pub fn reserve(&mut self, additional: usize)

Reserves capacity for at least additional more commands in the checkpoint.

Panics

Panics if the new capacity overflows usize.

pub fn capacity(&self) -> usize

Returns the capacity of the checkpoint.

pub fn shrink_to_fit(&mut self)

Shrinks the capacity of the checkpoint as much as possible.

pub fn len(&self) -> usize

Returns the number of commands in the checkpoint.

pub fn is_empty(&self) -> bool

Returns true if the checkpoint is empty.

pub fn commit(self)

Commits the changes and consumes the checkpoint.

impl<'_, C: Command, F: FnMut(Signal)> Checkpoint<'_, Record<C, F>, C>

pub fn apply(&mut self, command: C) -> Result<C>

Calls the apply method.

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

Calls the undo method.

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

Calls the redo method.

pub fn go_to(&mut self, current: usize) -> Option<Result<C>>

Calls the go_to method.

pub fn extend(&mut self, commands: impl IntoIterator<Item = C>) -> Result<C>

Calls the extend method.

pub fn cancel(self) -> Result<C>

Cancels the changes and consumes the checkpoint.

Errors

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

pub fn checkpoint(&mut self) -> Checkpoint<Record<C, F>, C>

Returns a checkpoint.

pub fn queue(&mut self) -> Queue<Record<C, F>, C>

Returns a queue.

pub fn as_target(&self) -> &C::Target

Returns a reference to the target.

pub fn as_mut_target(&mut self) -> &mut C::Target

Returns a mutable reference to the target.

This method should only be used when doing changes that should not be able to be undone.

impl<'_, C: Command, F: FnMut(Signal)> Checkpoint<'_, History<C, F>, C>

pub fn apply(&mut self, command: C) -> Result<C>

Calls the apply method.

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

Calls the undo method.

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

Calls the redo method.

pub fn go_to(&mut self, branch: usize, current: usize) -> Option<Result<C>>

Calls the go_to method.

pub fn extend(&mut self, commands: impl IntoIterator<Item = C>) -> Result<C>

Calls the extend method.

pub fn cancel(self) -> Result<C>

Cancels the changes and consumes the checkpoint.

Errors

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

pub fn checkpoint(&mut self) -> Checkpoint<History<C, F>, C>

Returns a checkpoint.

pub fn queue(&mut self) -> Queue<History<C, F>, C>

Returns a queue.

pub fn as_target(&self) -> &C::Target

Returns a reference to the target.

pub fn as_mut_target(&mut self) -> &mut C::Target

Returns a mutable reference to the target.

This method should only be used when doing changes that should not be able to be undone.

Trait Implementations

impl<'a, T, C> From<&'a mut T> for Checkpoint<'a, T, C>

fn from(inner: &'a mut T) -> Self

Performs the conversion.

impl<'a, T: Debug, C: Debug> Debug for Checkpoint<'a, T, C>

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

Formats the value using the given formatter.

impl<'a, T: PartialEq, C: PartialEq> PartialEq<Checkpoint<'a, T, C>> for Checkpoint<'a, T, C>

fn eq(&self, other: &Checkpoint<'a, T, C>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Checkpoint<'a, T, C>) -> bool

This method tests for !=.

impl<'a, T: Eq, C: Eq> Eq for Checkpoint<'a, T, C>

impl<'a, T: Ord, C: Ord> Ord for Checkpoint<'a, T, C>

fn cmp(&self, other: &Checkpoint<'a, T, C>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<'a, T: PartialOrd, C: PartialOrd> PartialOrd<Checkpoint<'a, T, C>> for Checkpoint<'a, T, C>

fn partial_cmp(&self, other: &Checkpoint<'a, T, C>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Checkpoint<'a, T, C>) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Checkpoint<'a, T, C>) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Checkpoint<'a, T, C>) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Checkpoint<'a, T, C>) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a, T: Hash, C: Hash> Hash for Checkpoint<'a, T, C>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl<'a, T, C> StructuralPartialEq for Checkpoint<'a, T, C>

impl<'a, T, C> StructuralEq for Checkpoint<'a, T, C>

impl<'_, C: Command, F> AsRef<<C as Command>::Target> for Checkpoint<'_, Record<C, F>, C>

fn as_ref(&self) -> &C::Target

Performs the conversion.

impl<'_, C: Command, F> AsRef<<C as Command>::Target> for Checkpoint<'_, History<C, F>, C>

fn as_ref(&self) -> &C::Target

Performs the conversion.

impl<'_, C: Command, F> AsMut<<C as Command>::Target> for Checkpoint<'_, Record<C, F>, C>

fn as_mut(&mut self) -> &mut C::Target

Performs the conversion.

impl<'_, C: Command, F> AsMut<<C as Command>::Target> for Checkpoint<'_, History<C, F>, C>

fn as_mut(&mut self) -> &mut C::Target

Performs the conversion.