Struct StackItem

pub struct StackItem<T> {
    pub meta: T,
    /* private fields */
}

A unit of work for the UndoManager. It contains a compressed information about all updates and deletions tracked by a corresponding undo manager. Whenever an [UndoManger::undo] or UndoManager::redo methods are called a last StackItem is being used to modify a state of the document.

Stack items are stored internally by undo manager and created automatically whenever a new update from tracked shared type and transaction of tracked origin has been committed within a threshold specified by Options::capture_timeout_millis time window since the previous stack item creation. They can also be created explicitly by calling UndoManager::reset, which marks the end of the last stack item batch.

Fields

meta: T

A custom user metadata that can be attached to a particular StackItem. It can be used to carry over the additional information (such as ie. user cursor position) between undo/redo operations.

Implementations

impl<M> StackItem<M>

where M: Default,

pub fn deletions(&self) -> &DeleteSet

A set of identifiers of element deleted at part of the timeframe current StackItem is responsible for.

pub fn insertions(&self) -> &DeleteSet

A set of identifiers of element inserted at part of the timeframe current StackItem is responsible for.

Trait Implementations

impl<T> Clone for StackItem<T>

where T: Clone,

fn clone(&self) -> StackItem<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for StackItem<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<M> Display for StackItem<M>

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

Formats the value using the given formatter.

impl<T> Hash for StackItem<T>

where T: Hash,

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T> PartialEq for StackItem<T>

where T: PartialEq,

fn eq(&self, other: &StackItem<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> Eq for StackItem<T>

where T: Eq,

impl<T> StructuralPartialEq for StackItem<T>