Struct undo::record::Queue

pub struct Queue<'a, C: Command, F> { /* fields omitted */ }

Wraps a record and gives it batch queue functionality.

Examples

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

Implementations

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

pub fn apply(&mut self, command: C)

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, target: &mut C::Target) -> Result<C>

Applies the queued commands.

Errors

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

pub fn cancel(self)

Cancels the queued actions.

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

Returns a queue.

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

Returns a checkpoint.

Trait Implementations

impl<'a, C: Command, F> From<&'a mut Record<C, F>> for Queue<'a, C, F>

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

Performs the conversion.