Struct undo::history::Queue

pub struct Queue<'a, A, S> { /* private fields */ }

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(Push('a'));
queue.apply(Push('b'));
queue.apply(Push('c'));
assert_eq!(string, "");

queue.commit(&mut string);
assert_eq!(string, "abc");

Implementations

impl<A, S> Queue<'_, A, S>

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

Returns a queue.

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

Returns a checkpoint.

impl<A: Action, S: Slot> Queue<'_, A, S>

pub fn apply(&mut self, action: A)

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 A::Target) -> Vec<A::Output>

Applies the queued actions.

pub fn cancel(self)

Cancels the queued actions.

Trait Implementations

impl<'a, A: Debug, S: Debug> Debug for Queue<'a, A, S>

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

Formats the value using the given formatter.

impl<'a, A, S> From<&'a mut History<A, S>> for Queue<'a, A, S>

fn from(history: &'a mut History<A, S>) -> Self

Converts to this type from the input type.