Struct undo::Record

pub struct Record<R> { /* private fields */ }

A record of commands.

The record can roll the receivers state backwards and forwards by using the undo and redo methods. In addition, the record can notify the user about changes to the stack or the receiver through signal. The user can give the record a function that is called each time the state changes by using the builder.

Examples

#[derive(Debug)]
struct Add(char);

impl Command<String> for Add {
    fn apply(&mut self, s: &mut String) -> undo::Result {
        s.push(self.0);
        Ok(())
    }

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

fn main() -> undo::Result {
    let mut record = Record::default();
    record.apply(Add('a'))?;
    record.apply(Add('b'))?;
    record.apply(Add('c'))?;
    assert_eq!(record.as_receiver(), "abc");
    record.undo().unwrap()?;
    record.undo().unwrap()?;
    record.undo().unwrap()?;
    assert_eq!(record.as_receiver(), "");
    record.redo().unwrap()?;
    record.redo().unwrap()?;
    record.redo().unwrap()?;
    assert_eq!(record.as_receiver(), "abc");
    Ok(())
}

Implementations

impl<R> Record<R>

pub fn new(receiver: impl Into<R>) -> Record<R>

Returns a new record.

pub fn builder() -> RecordBuilder<R>

Returns a builder for a record.

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

Reserves capacity for at least additional more commands.

Panics

Panics if the new capacity overflows usize.

pub fn capacity(&self) -> usize

Returns the capacity of the record.

pub fn len(&self) -> usize

Returns the number of commands in the record.

pub fn is_empty(&self) -> bool

Returns true if the record is empty.

pub fn limit(&self) -> usize

Returns the limit of the record.

pub fn set_limit(&mut self, limit: usize) -> usize

Sets the limit of the record and returns the new limit.

If this limit is reached it will start popping of commands at the beginning of the record when new commands are applied. No limit is set by default which means it may grow indefinitely.

If limit < len the first commands will be removed until len == limit. However, if the current active command is going to be removed, the limit is instead adjusted to len - active so the active command is not removed.

Panics

Panics if limit is 0.

pub fn connect<F>(&mut self, f: impl Into<Option<F>>)where
    F: FnMut(Signal) + Send + Sync + 'static,

Sets how the signal should be handled when the state changes.

pub fn can_undo(&self) -> bool

Returns true if the record can undo.

pub fn can_redo(&self) -> bool

Returns true if the record can redo.

pub fn set_saved(&mut self, saved: bool)

Marks the receiver as currently being in a saved or unsaved state.

pub fn is_saved(&self) -> bool

Returns true if the receiver is in a saved state, false otherwise.

pub fn revert(&mut self) -> Option<Result>

Revert the changes done to the receiver since the saved state.

pub fn cursor(&self) -> usize

Returns the position of the current command.

pub fn clear(&mut self)

Removes all commands from the record without undoing them.

pub fn apply(&mut self, command: impl Command<R> + 'static) -> Resultwhere
    R: 'static,

Pushes the command to the top of the record and executes its apply method.

Errors

If an error occur when executing apply the error is returned and the command is removed.

pub fn undo(&mut self) -> Option<Result>

Calls the undo method for the active command and sets the previous one as the new active one.

Errors

If an error occur when executing undo the error is returned and the command is removed.

pub fn redo(&mut self) -> Option<Result>

Calls the redo method for the active command and sets the next one as the new active one.

Errors

If an error occur when executing redo the error is returned and the command is removed.

pub fn go_to(&mut self, cursor: usize) -> Option<Result>

Repeatedly calls undo or redo until the command at cursor is reached.

Errors

If an error occur when executing undo or redo the error is returned and the command is removed.

pub fn extend<C: Command<R> + 'static>(
    &mut self,
    commands: impl IntoIterator<Item = C>
) -> Resultwhere
    R: 'static,

Applies each command in the iterator.

Errors

If an error occur when executing apply the error is returned and the command is removed. The remaining commands in the iterator are discarded.

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

Returns a checkpoint.

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

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.

pub fn into_receiver(self) -> R

Consumes the record, returning the receiver.

Trait Implementations

impl<R> AsMut<R> for Record<R>

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

Converts this type into a mutable reference of the (usually inferred) input type.

impl<R> AsRef<R> for Record<R>

fn as_ref(&self) -> &R

Converts this type into a shared reference of the (usually inferred) input type.

impl<R: Debug> Debug for Record<R>

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

Formats the value using the given formatter.

impl<R: Default> Default for Record<R>

fn default() -> Record<R>

Returns the “default value” for a type.

impl<R> From<History<R>> for Record<R>

fn from(history: History<R>) -> Record<R>

Converts to this type from the input type.

impl<R> From<R> for Record<R>

fn from(receiver: R) -> Record<R>

Converts to this type from the input type.

impl<R> From<Record<R>> for History<R>

fn from(record: Record<R>) -> History<R>

Converts to this type from the input type.