Skip to main content

HistoryService

Struct HistoryService 

Source
pub struct HistoryService { /* private fields */ }
Expand description

History service for undo/redo operations

Implementations§

Source§

impl HistoryService

Source

pub fn new() -> Self

Create a new history service with default settings

Source

pub fn with_max_size(max_size: usize) -> Self

Create a history that keeps at most max_size undo steps, dropping the oldest first; 0 keeps every step.

Source

pub fn push_snapshot(&mut self, drawings: Vec<(usize, Drawing)>)

Record the drawings a bulk edit changes or removes, each with its list index before the edit, as one undo step. Undo restores only these drawings.

Source

pub fn push_add(&mut self, drawing: Drawing)

Record that a drawing was added

Source

pub fn push_delete(&mut self, drawing: Drawing, index: usize)

Record that a drawing was deleted from list index index

Source

pub fn push_modify(&mut self, id: usize, old_state: Drawing)

Record that a drawing was modified

Source

pub fn undo(&mut self, drawings: &mut Vec<Drawing>) -> Option<usize>

Undo the last operation

Returns the ID of the affected drawing, if any.

Source

pub fn redo(&mut self, drawings: &mut Vec<Drawing>) -> Option<usize>

Redo the last undone operation

Returns the ID of the affected drawing, if any.

Source

pub fn can_undo(&self) -> bool

Check if undo is available

Source

pub fn can_redo(&self) -> bool

Check if redo is available

Source

pub fn undo_count(&self) -> usize

Get the number of undo operations available

Source

pub fn redo_count(&self) -> usize

Get the number of redo operations available

Source

pub fn clear(&mut self)

Clear all history

Source

pub fn shift_bar_indices(&mut self, from: f32, delta: f32)

Shift the bar indices at or after from in history (for bars inserted in front of them)

Source

pub fn prune(&mut self, existing_ids: &HashSet<usize>)

Prune undo history entries for drawings that no longer exist.

Only the undo stack is pruned against the live id set. The redo stack is intentionally left intact: a redo entry legitimately references a drawing that is absent from the live set. After an Add is undone, the drawing is removed from the live set but its re-adding command sits on the redo stack; pruning the redo stack against live ids would silently drop that entry and lose the redo. The redo stack is the authoritative record of what redo would restore, so it is the wrong place to enforce live-id membership.

Source

pub fn last_undo_description(&self) -> Option<&'static str>

Get description of the last undoable action (for UI)

Source

pub fn last_redo_description(&self) -> Option<&'static str>

Get description of the last redoable action (for UI)

Trait Implementations§

Source§

impl Clone for HistoryService

Source§

fn clone(&self) -> HistoryService

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for HistoryService

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for HistoryService

Source§

fn default() -> HistoryService

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

Auto Trait Implementations§

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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
Source§

impl<T> MaybeSend for T
where T: Send + Sync + ?Sized,

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

§

impl<T> SerializableAny for T
where T: 'static + Any + Clone + for<'a> Send + Sync,

§

impl<T, S> SimdFrom<T, S> for T
where S: Simd,

§

fn simd_from(_simd: S, value: T) -> T

§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

§

fn simd_into(self, simd: S) -> T

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.