Development Documentation (main branch) - For stable release docs, see docs.rs/eidetica

Options

Struct Options 

pub struct Options<M> {
    pub capture_timeout_millis: u64,
    pub tracked_origins: HashSet<Origin>,
    pub capture_transaction: Option<Arc<dyn Fn(&TransactionMut<'_>) -> bool + Send + Sync>>,
    pub timestamp: Arc<dyn Clock>,
    pub init_undo_stack: Vec<StackItem<M>>,
    pub init_redo_stack: Vec<StackItem<M>>,
}
Expand description

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: Option<Arc<dyn Fn(&TransactionMut<'_>) -> bool + Send + Sync>>

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

§timestamp: Arc<dyn Clock>

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

§init_undo_stack: Vec<StackItem<M>>

Initial undo stack that can be pre-filled with some operations that can be undone.

§init_redo_stack: Vec<StackItem<M>>

Initial redo stack that can be pre-filled with some operations that can be redone.

Trait Implementations§

§

impl<M> Default for Options<M>

Available on non-target_family=wasm only.
§

fn default() -> Options<M>

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

Auto Trait Implementations§

§

impl<M> Freeze for Options<M>

§

impl<M> !RefUnwindSafe for Options<M>

§

impl<M> Send for Options<M>
where M: Send,

§

impl<M> Sync for Options<M>
where M: Sync,

§

impl<M> Unpin for Options<M>
where M: Unpin,

§

impl<M> !UnwindSafe for Options<M>

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
§

impl<T> CompatExt for T

§

fn compat(self) -> Compat<T>

Applies the [Compat] adapter by value. Read more
§

fn compat_ref(&self) -> Compat<&T>

Applies the [Compat] adapter by shared reference. Read more
§

fn compat_mut(&mut self) -> Compat<&mut T>

Applies the [Compat] adapter by mutable reference. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

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

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<M> Meta for M
where M: Default,