Struct History 

pub struct History<I: HistoryItem> { /* private fields */ }

The History is used to keep track of changes to a model and to allow undo and redo operations.

This is now used in Input for undo/redo operations. You can also use this in your own models to keep track of changes, for example to track the tab history for prev/next features.

Use cases

• Undo/redo operations in Input
• Tracking tab history for prev/next features

Implementations

impl<I> History<I>

where I: HistoryItem,

pub fn new() -> Self

pub fn max_undos(self, max_undos: usize) -> Self

Set the maximum number of undo steps to keep, defaults to 1000.

pub fn unique(self) -> Self

Set the history to be unique, defaults to false. If set to true, the history will only keep unique changes.

pub fn group_interval(self, group_interval: Duration) -> Self

Set the interval in milliseconds to group changes, defaults to None.

pub fn start_grouping(&mut self)

Start grouping changes, this will prevent the version from being incremented until end_grouping is called.

pub fn end_grouping(&mut self)

End grouping changes, this will allow the version to be incremented again.

pub fn version(&self) -> usize

Get the current version number.

pub fn push(&mut self, item: I)

Push a new change to the history.

pub fn undos(&self) -> &Vec<I>

Get the undo stack.

pub fn redos(&self) -> &Vec<I>

Get the redo stack.

pub fn clear(&mut self)

Clear the undo and redo stacks.

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

Undo the last change and return the changes that were undone.

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

Redo the last undone change and return the changes that were redone.

Trait Implementations

impl<I: Debug + HistoryItem> Debug for History<I>

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

Formats the value using the given formatter.