Skip to main content

HistoryManager

Struct HistoryManager 

Source
pub struct HistoryManager { /* private fields */ }
Expand description

Manager for undo/redo history.

Maintains dual stacks for undo and redo operations with configurable memory and depth limits.

Implementations§

Source§

impl HistoryManager

Source

pub fn new(config: HistoryConfig) -> Self

Create a new history manager with the given configuration.

Source

pub fn push(&mut self, cmd: Box<dyn UndoableCmd>)

Push a command onto the undo stack.

This clears the redo stack (new branch) and enforces limits. The command is NOT executed - it’s assumed to have already been executed.

Source

pub fn undo(&mut self) -> Option<Result<String, CommandError>>

Undo the last command.

Moves the command from undo stack to redo stack and calls undo().

§Returns
  • Ok(description) if undo succeeded
  • Err(error) if undo failed (command remains on undo stack)
  • None if no commands to undo
Source

pub fn redo(&mut self) -> Option<Result<String, CommandError>>

Redo the last undone command.

Moves the command from redo stack to undo stack and calls redo().

§Returns
  • Ok(description) if redo succeeded
  • Err(error) if redo failed (command remains on redo stack)
  • None if no commands to redo
Source

pub fn can_undo(&self) -> bool

Check if undo is available.

Source

pub fn can_redo(&self) -> bool

Check if redo is available.

Source

pub fn undo_depth(&self) -> usize

Get the undo stack depth.

Source

pub fn redo_depth(&self) -> usize

Get the redo stack depth.

Source

pub fn undo_descriptions(&self, limit: usize) -> Vec<&str>

Get descriptions for undo commands (most recent first).

Source

pub fn redo_descriptions(&self, limit: usize) -> Vec<&str>

Get descriptions for redo commands (most recent first).

Source

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

Get the description of the next undo command.

Source

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

Get the description of the next redo command.

Source

pub fn memory_usage(&self) -> usize

Get total memory usage in bytes.

Source

pub fn config(&self) -> &HistoryConfig

Get the current configuration.

Source

pub fn clear(&mut self)

Clear all history (both undo and redo).

Trait Implementations§

Source§

impl Debug for HistoryManager

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for HistoryManager

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more