Struct undo::Checkpoint

pub struct Checkpoint<'a, T, R> { /* private fields */ }

A checkpoint wrapper.

Wraps a Record or History and gives it checkpoint functionality.

Examples

#[derive(Debug)]
struct Add(char);

impl Command<String> for Add {
    fn apply(&mut self, s: &mut String) -> Result<(), Box<dyn Error + Send + Sync>> {
        s.push(self.0);
        Ok(())
    }

    fn undo(&mut self, s: &mut String) -> Result<(), Box<dyn Error + Send + Sync>> {
        self.0 = s.pop().ok_or("`s` is empty")?;
        Ok(())
    }
}

fn main() -> undo::Result<String> {
    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_receiver(), "abc");
    cp.cancel()?;
    assert_eq!(record.as_receiver(), "");
    Ok(())
}

Implementations

impl<R> Checkpoint<'_, Record<R>, R>

pub fn apply(&mut self, command: impl Command<R> + 'static) -> Result<R>where
    R: 'static,

Calls the apply method.

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

Calls the undo method.

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

Calls the redo method.

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

Calls the go_to method.

pub fn commit(self)

Commits the changes and consumes the checkpoint.

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

Cancels the changes and consumes the checkpoint.

Errors

If an error occur when canceling the changes, the error is returned together with the command.

pub fn checkpoint(&mut self) -> Checkpoint<'_, Record<R>, R>

Returns a checkpoint.

pub fn queue(&mut self) -> Queue<'_, Record<R>, R>

Returns a queue.

pub fn as_receiver(&self) -> &R

Returns a reference to the receiver.

pub fn as_mut_receiver(&mut self) -> &mut R

Returns a mutable reference to the receiver.

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

impl<R> Checkpoint<'_, History<R>, R>

pub fn apply(&mut self, command: impl Command<R> + 'static) -> Result<R>where
    R: 'static,

Calls the apply method.

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

Calls the undo method.

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

Calls the redo method.

pub fn go_to(&mut self, branch: usize, cursor: usize) -> Option<Result<R>>where
    R: 'static,

Calls the go_to method.

pub fn commit(self)

Commits the changes and consumes the checkpoint.

pub fn cancel(self) -> Result<R>where
    R: 'static,

Cancels the changes and consumes the checkpoint.

Errors

If an error occur when canceling the changes, the error is returned together with the command.

pub fn checkpoint(&mut self) -> Checkpoint<'_, History<R>, R>

Returns a checkpoint.

pub fn queue(&mut self) -> Queue<'_, History<R>, R>

Returns a queue.

pub fn as_receiver(&self) -> &R

Returns a reference to the receiver.

pub fn as_mut_receiver(&mut self) -> &mut R

Returns a mutable reference to the receiver.

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

Trait Implementations

impl<R> AsMut<R> for Checkpoint<'_, History<R>, R>

fn as_mut(&mut self) -> &mut R

Converts this type into a mutable reference of the (usually inferred) input type.

impl<R> AsMut<R> for Checkpoint<'_, Record<R>, R>

fn as_mut(&mut self) -> &mut R

Converts this type into a mutable reference of the (usually inferred) input type.

impl<R> AsRef<R> for Checkpoint<'_, History<R>, R>

fn as_ref(&self) -> &R

Converts this type into a shared reference of the (usually inferred) input type.

impl<R> AsRef<R> for Checkpoint<'_, Record<R>, R>

fn as_ref(&self) -> &R

Converts this type into a shared reference of the (usually inferred) input type.

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

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

Formats the value using the given formatter.

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

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

Converts to this type from the input type.