Struct yrs::undo::Options

pub struct Options {
    pub capture_timeout_millis: u64,
    pub tracked_origins: HashSet<Origin>,
    pub capture_transaction: Rc<dyn Fn(&TransactionMut<'_>) -> bool>,
    pub timestamp: Rc<dyn Fn() -> u64>,
}

Set of options used to configure UndoManager.

Fields

capture_timeout_millis: u64

Undo-/redo-able updates are grouped together in time-constrained snapshots. This field determines the period of time, every snapshot will be automatically made in.

tracked_origins: HashSet<Origin>

List of origins tracked by corresponding UndoManager. If provided, it will track only updates made within transactions of specific origin. If not provided, it will track only updates made within transaction with no origin defined.

capture_transaction: Rc<dyn Fn(&TransactionMut<'_>) -> bool>

Custom logic decider, that along with [tracked_origins] can be used to determine if transaction changes should be captured or not.

timestamp: Rc<dyn Fn() -> u64>

Custom clock function, that can be used to generate timestamps used by Options::capture_timeout_millis.

Trait Implementations

impl Clone for Options

fn clone(&self) -> Options

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Options

fn default() -> Self

Returns the “default value” for a type.