Struct CommandHistory 

pub struct CommandHistory { /* private fields */ }

Fixed-capacity undo/redo stack.

New commands push onto undo_stack and clear redo_stack. Undo pops from undo_stack, applies reverse, pushes onto redo_stack. Redo pops from redo_stack, applies forward, pushes onto undo_stack.

Implementations

impl CommandHistory

pub fn new(max_size: usize) -> CommandHistory

Creates a new history with the given maximum stack depth.

pub fn push(&mut self, cmd: EditorCommand)

Push a command after executing its forward edit.

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

Undo the last command. Returns the reverse PropertyEdit to apply.

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

Redo the last undone command. Returns the forward PropertyEdit to apply.

pub fn can_undo(&self) -> bool

Whether there is anything to undo.

pub fn can_redo(&self) -> bool

Whether there is anything to redo.

pub fn undo_description(&self) -> Option<&str>

Description of the next undoable command (for UI display).

pub fn redo_description(&self) -> Option<&str>

Description of the next redoable command (for UI display).

pub fn undo_depth(&self) -> usize

Number of commands currently on the undo stack. Bounded by the configured maximum depth.

Trait Implementations

impl Clone for CommandHistory

fn clone(&self) -> CommandHistory

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CommandHistory

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

Formats the value using the given formatter.

impl Default for CommandHistory

fn default() -> CommandHistory

Returns the “default value” for a type.