Struct undo::Queue

pub struct Queue<'a, T: 'static> { /* fields omitted */ }

A command queue wrapper.

Wraps a record or history and gives it batch queue functionality. This allows the record or history to queue up commands and either cancel or apply them later.

Examples

let mut record = Record::default();
let mut queue = record.queue();
queue.apply(Add('a'));
queue.apply(Add('b'));
queue.apply(Add('c'));
assert_eq!(queue.target(), "");
queue.commit()?;
assert_eq!(record.target(), "abc");

Implementations

impl<'a, T> Queue<'a, T>

pub fn apply(&mut self, command: impl Command<T>)

Queues an apply action.

pub fn undo(&mut self)

Queues an undo action.

pub fn redo(&mut self)

Queues a redo action.

pub fn commit(self) -> Result

Applies the actions that is queued.

Errors

If an error occurs, it stops applying the actions and returns the error.

pub fn cancel(self)

Cancels the queued actions.

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

Returns a queue.

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

Returns a checkpoint.

pub fn target(&self) -> &T

Returns a reference to the target.

Trait Implementations

impl<'a, T: Debug + 'static> Debug for Queue<'a, T>

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

Formats the value using the given formatter.

impl<'a, T> From<&'a mut Record<T>> for Queue<'a, T>

fn from(record: &'a mut Record<T>) -> Self

Performs the conversion.