#undo #redo

no-std redo

Provides advanced undo-redo functionality with static dispatch

70 releases (36 breaking)

✓ Uses Rust 2018 edition

0.40.0 Feb 16, 2020
0.39.0 Nov 15, 2019
0.38.0 Nov 1, 2019
0.35.0 Jul 2, 2019
0.2.1 Feb 15, 2017

#79 in Data structures

Download history 2/week @ 2020-01-29 1/week @ 2020-02-05 85/week @ 2020-02-12 160/week @ 2020-02-19 143/week @ 2020-02-26 142/week @ 2020-03-04 71/week @ 2020-03-11 212/week @ 2020-03-18 70/week @ 2020-03-25 2/week @ 2020-04-01 282/week @ 2020-04-08 215/week @ 2020-04-15 2/week @ 2020-04-22 3/week @ 2020-04-29 213/week @ 2020-05-13

461 downloads per month

MIT/Apache and maybe MPL-2.0

81KB
2K SLoC

redo

Travis Crates.io Docs

Provides advanced undo-redo functionality with static dispatch.

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 target.

Features

  • 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.
  • A queue wraps a record or history and extends them with queue functionality.
  • A checkpoint wraps a record or history and extends them with checkpoint functionality.
  • 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 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 Display.
  • Time stamps and time travel is provided when the chrono feature is enabled.
  • Serialization and deserialization is provided when the serde feature is enabled.
  • The library can be used as no_std by default.

Examples

use redo::{Command, Record};

struct Add(char);

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

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

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

fn main() -> redo::Result<Add> {
    let mut record = Record::default();
    record.apply(Add('a'))?;
    record.apply(Add('b'))?;
    record.apply(Add('c'))?;
    assert_eq!(record.target(), "abc");
    record.undo()?;
    record.undo()?;
    record.undo()?;
    assert_eq!(record.target(), "");
    record.redo()?;
    record.redo()?;
    record.redo()?;
    assert_eq!(record.target(), "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

~0–400KB