Struct redo::Queue

pub struct Queue<'a, T, C> { /* 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

struct Add(char);

impl Command<String> for Add {
    type Error = &'static str;

    fn apply(&mut self, s: &mut String) -> Result<(), Self::Error> {
        s.push(self.0);
        Ok(())
    }

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

fn main() -> Result<(), &'static str> {
    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.as_receiver(), "");
    queue.commit()?;
    assert_eq!(record.as_receiver(), "abc");
    Ok(())
}

Methods

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

pub fn new(inner: &'a mut T) -> Queue<'a, T, C>

Returns a queue.

pub fn reserve(&mut self, additional: usize)

Reserves capacity for at least additional more commands in the queue.

Panics

Panics if the new capacity overflows usize.

pub fn capacity(&self) -> usize

Returns the capacity of the queue.

pub fn len(&self) -> usize

Returns the number of commands in the queue.

pub fn is_empty(&self) -> bool

Returns true if the queue is empty.

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 cancel(self)

Cancels the queued actions.

impl<R, C: Command<R>, '_> Queue<'_, Record<R, C>, C>

pub fn go_to(&mut self, current: usize)

Queues a go_to action.

pub fn commit(self) -> Result<(), C::Error>

Applies the actions that is queued.

Errors

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

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

Returns a checkpoint.

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

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, C: Command<R>, '_> Queue<'_, History<R, C>, C>

pub fn go_to(&mut self, branch: usize, current: usize)

Queues a go_to action.

pub fn commit(self) -> Result<(), C::Error>

Applies the actions that is queued.

Errors

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

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

Returns a checkpoint.

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

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<T, C, '_> Extend<C> for Queue<'_, T, C>

fn extend<I: IntoIterator<Item = C>>(&mut self, commands: I)

Extends a collection with the contents of an iterator.

impl<R, C: Command<R>, '_> AsMut<R> for Queue<'_, Record<R, C>, C>

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

Performs the conversion.

impl<R, C: Command<R>, '_> AsMut<R> for Queue<'_, History<R, C>, C>

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

Performs the conversion.

impl<R, C: Command<R>, '_> AsRef<R> for Queue<'_, Record<R, C>, C>

fn as_ref(&self) -> &R

Performs the conversion.

impl<R, C: Command<R>, '_> AsRef<R> for Queue<'_, History<R, C>, C>

fn as_ref(&self) -> &R

Performs the conversion.

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

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

Performs the conversion.

impl<'a, T: Debug, C: Debug> Debug for Queue<'a, T, C>

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

Formats the value using the given formatter.