Crate undo[−][src]
Low-level undo-redo functionality.
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 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.
- 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 the display structure.
- The library can be used as
no_std
.
Cargo Feature Flags
chrono
: Enables time stamps and time travel.serde
: Enables serialization and deserialization.colored
: Enables colored output when visualizing the display structures.
Re-exports
pub use self::timeline::Timeline; |
pub use self::history::History; |
pub use self::record::Record; |
Modules
history | A history of commands. |
record | A record of commands. |
timeline | A timeline of commands. |
Enums
Merge | Says if the command have been merged with another command. |
Signal | The signal used for communicating state changes. |
Traits
Command | Base functionality for all commands. |
Type Definitions
Result | A specialized Result type for undo-redo operations. |