Struct undo::record::Queue

pub struct Queue<'a, E, 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.edit(Add('a'));
queue.edit(Add('b'));
queue.edit(Add('c'));
assert_eq!(string, "");

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

Implementations

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

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

Returns a queue.

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

Returns a checkpoint.

pub fn edit(&mut self, edit: E)

Queues a Record::edit call.

pub fn undo(&mut self)

Queues a Record::undo call.

pub fn redo(&mut self)

Queues a Record::redo call.

pub fn cancel(self)

Cancels the queued edits.

impl<E: Edit, S: Slot> Queue<'_, E, S>

pub fn commit(self, target: &mut E::Target) -> Vec<E::Output>

Applies the queued edits.

Trait Implementations

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

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

Formats the value using the given formatter.

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

fn from(record: &'a mut Record<E, S>) -> Self

Converts to this type from the input type.