Skip to main content

UndoLog

Struct UndoLog 

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

Undo log with configurable maximum depth.

Implementations§

Source§

impl UndoLog

Source

pub fn new(max_entries: usize) -> Self

Create a new undo log with the specified maximum entries.

Source

pub fn record( &mut self, operation: UndoableOperation, description: impl Into<String>, ) -> u64

Record an operation in the undo log.

Returns the ID assigned to this entry.

Source

pub fn record_move(&mut self, moves: Vec<(PathBuf, PathBuf)>) -> u64

Record a move operation.

Source

pub fn record_copy(&mut self, created: Vec<PathBuf>) -> u64

Record a copy operation.

Source

pub fn record_delete(&mut self, paths: Vec<PathBuf>) -> u64

Record a delete operation.

Source

pub fn record_rename(&mut self, source: PathBuf, new_name: String) -> u64

Record a rename operation.

source is the full original path before the rename. new_name is the new name component (used for the description).

Source

pub fn record_create_file(&mut self, path: PathBuf) -> u64

Record a file creation.

Source

pub fn record_create_directory(&mut self, path: PathBuf) -> u64

Record a directory creation.

Source

pub fn pop(&mut self) -> Option<UndoEntry>

Pop the most recent undoable entry.

Returns None if the log is empty or the back entry cannot be undone. Does NOT drain through non-undoable entries — only examines the back.

Source

pub fn peek(&self) -> Option<&UndoEntry>

Peek at the most recent entry without removing it.

Source

pub fn len(&self) -> usize

Get the number of entries in the log.

Source

pub fn is_empty(&self) -> bool

Check if the log is empty.

Source

pub fn clear(&mut self)

Clear all entries from the log.

Source

pub fn iter(&self) -> impl Iterator<Item = &UndoEntry>

Get an iterator over all entries (oldest first).

Trait Implementations§

Source§

impl Debug for UndoLog

Source§

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

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

impl Default for UndoLog

Source§

fn default() -> Self

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

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

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

impl<T> WithSubscriber for T

Source§

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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