Enum HistoryMode 

#[non_exhaustive]
pub enum HistoryMode {
    Record,
    RecordPreserveRedo,
    Ignore,
}

What a history above the scene should do with this transaction.

Three-valued, matching what the editors that have solved this converged on (tldraw’s history: 'record' | 'record-preserveRedoStack' | 'ignore'). The framework never interprets it. It carries it faithfully and nothing else — which is the whole point: deciding what counts as an undo step is the data layer’s job, and the scene’s job is to make the decision expressible.

#[non_exhaustive]: this crate has out-of-tree consumers.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Record

A document edit: push an entry, clear redo. The default.

RecordPreserveRedo

Push an entry but leave the redo stack alone. For a change that is undoable without invalidating a redo branch.

Ignore

Do not push. Views still reconcile; history does not move.

Trait Implementations

impl Clone for HistoryMode

fn clone(&self) -> HistoryMode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for HistoryMode

impl Debug for HistoryMode

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

Formats the value using the given formatter.

impl Default for HistoryMode

fn default() -> HistoryMode

Returns the “default value” for a type.

impl Eq for HistoryMode

impl PartialEq for HistoryMode

fn eq(&self, other: &HistoryMode) -> bool

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for HistoryMode