undo

Low-level undo-redo functionality.

It is an implementation of the command pattern, where all modifications are done by creating objects that applies the modifications. All objects knows how to undo the changes it applies, and by using the provided data structures it is easy to apply, undo, and redo changes made to a target.

Features

Action provides the base functionality for all actions.
Record provides basic undo-redo functionality.
Timeline provides basic undo-redo functionality using a fixed size.
History provides non-linear undo-redo functionality that allows you to jump between different branches.
Queues wraps a record or history and extends them with queue functionality.
Checkpoints wraps a record or history and extends them with checkpoint functionality.
Actions can be merged into a single action by implementing the merge method on the action. This allows smaller actions to be used to build more complex operations, or smaller incremental changes to be merged into larger changes that can be undone and redone in a single step.
The target can be marked as being saved to disk and the data-structures can track the saved state and notify when it changes.
The amount of changes being tracked can be configured by the user so only the N most recent changes are stored.
Configurable display formatting using the display structure.
The library can be used as no_std.

Cargo Feature Flags

alloc: Enables the use of the alloc crate, enabled by default.
arrayvec: Required for the timeline module, enabled by default.
chrono: Enables time stamps and time travel.
serde: Enables serialization and deserialization.
colored: Enables colored output when visualizing the display structures.

Examples

use undo::{Action, Record};

struct Add(char);

impl Action for Add {
    type Target = String;
    type Error = &'static str;

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

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

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

License

Licensed under either of

Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Contribution