#undo #redo

redo

Provides undo-redo functionality with static dispatch and manual command merging

63 releases (30 breaking)

✓ Uses Rust 2018 edition

0.34.0 May 14, 2019
0.32.1 Mar 25, 2019
0.29.8 Dec 17, 2018
0.29.2 Nov 28, 2018
0.2.1 Feb 15, 2017

#46 in Data structures

Download history 13/week @ 2019-01-26 24/week @ 2019-02-02 15/week @ 2019-02-09 3/week @ 2019-02-16 5/week @ 2019-02-23 122/week @ 2019-03-02 5/week @ 2019-03-09 6/week @ 2019-03-16 147/week @ 2019-03-23 5/week @ 2019-03-30 64/week @ 2019-04-06 3/week @ 2019-04-13 72/week @ 2019-04-20 57/week @ 2019-04-27 64/week @ 2019-05-04

185 downloads per month

MIT/Apache

102KB
2K SLoC

redo

Travis Crates.io Docs

Provides undo-redo functionality with static dispatch and manual command merging.

It is an implementation of the command pattern, where all modifications are done by creating objects of commands that applies the modifications. All commands 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 receiver. Both linear and non-linear undo-redo functionality is provided through the Record and History data structures. This library provides more or less the same functionality as the undo library but is more focused on performance instead of ease of use.

Contents

  • Command provides the base functionality for all commands.
  • Record provides linear undo-redo functionality.
  • History provides non-linear undo-redo functionality that allows you to jump between different branches.
  • Queue wraps a Record or History and extends them with queue functionality.
  • Checkpoint wraps a Record or History and extends them with checkpoint functionality.
  • Configurable display formatting is provided through the Display structure.
  • Time stamps and time travel is provided when the chrono feature is enabled.
  • Serialization and deserialization is provided when the serde feature is enabled.

Concepts

  • Commands can be merged into a single command by implementing the merge method on the command. This allows smaller commands 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 receiver can be marked as being saved to disk and the data-structures can track the saved state and tell the user when it changes.
  • The amount of changes being tracked can be configured by the user so only the n most recent changes are stored.

Examples

Add this to Cargo.toml:

[dependencies]
redo = "0.34"

And this to main.rs:

use redo::{Command, Record};

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();
    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(())
}

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Dependencies

~1.5MB
~25K SLoC