Skip to main content

History

Struct History 

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

Change history log.

Records all changes made to a buffer in chronological order. Unlike UndoTree, this is a simple linear log without branching.

§Use Cases

  • Debugging: See what changes were made and when
  • Auditing: Track modification history
  • Collaboration: Synchronize changes between editors

§Memory Management

The history has a configurable maximum number of entries. When exceeded, the oldest entries are removed.

Implementations§

Source§

impl History

Source

pub const DEFAULT_MAX_ENTRIES: usize = 10000

Default maximum number of entries.

Source

pub fn new() -> Self

Create a new empty history.

Source

pub fn with_max_entries(max_entries: usize) -> Self

Create a new history with custom maximum entries.

Source

pub fn record(&mut self, edits: Vec<Edit>)

Record a new change.

Source

pub fn entries(&self) -> &[HistoryEntry]

Get all entries in chronological order.

Source

pub fn last(&self) -> Option<&HistoryEntry>

Get the most recent entry.

Source

pub fn get(&self, index: usize) -> Option<&HistoryEntry>

Get an entry by index.

Source

pub fn clear(&mut self)

Clear all history.

Source

pub const fn len(&self) -> usize

Get the number of entries.

Source

pub const fn is_empty(&self) -> bool

Check if history is empty.

Source

pub const fn max_entries(&self) -> usize

Get the maximum entries limit.

Source

pub fn set_max_entries(&mut self, max: usize)

Set the maximum entries limit.

Source

pub const fn seq_counter(&self) -> u64

Get the current sequential counter value.

Source

pub fn since(&self, seq_num: u64) -> Vec<&HistoryEntry>

Get entries since a given sequence number.

Source

pub fn between(&self, start: Instant, end: Instant) -> Vec<&HistoryEntry>

Get entries within a time range.

Trait Implementations§

Source§

impl Debug for History

Source§

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

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

impl Default for History

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, 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, 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.