Skip to main content

UndoEntry

Struct UndoEntry 

Source
pub struct UndoEntry<C> { /* private fields */ }
Expand description

One reversible unit — a snapshot of a single document state (TR-010).

Restoring an entry reproduces the document at this state: the CST snapshot, the exact prior buffer bytes (source_text), and the caller’s cursor value (cursor). Generic over the cursor/metadata type C so ronin-core stays decoupled from any surface’s cursor representation (see module docs).

§Downstream reuse (E005 / E008 — TR-013)

Downstream editing epics build an entry with new after applying an edit, then hand it to UndoStack::record. On undo/redo they read back the snapshot through source_text (write to the buffer verbatim — exact-prior-byte restore), cst_snapshot (reuse the structurally-shared tree without re-parsing), and cursor (restore caret/selection).

Implementations§

Source§

impl<C> UndoEntry<C>

Source

pub fn new(cst_snapshot: CstDocument, source_text: String, cursor: C) -> Self

Snapshot a document state into a new undo unit.

cst_snapshot should correspond to source_text (the CST whose printout is those exact bytes); cursor is the surface state to restore alongside.

Source

pub fn cst_snapshot(&self) -> &CstDocument

The CST snapshot at this state.

Source

pub fn source_text(&self) -> &str

The exact prior buffer text this unit restores.

Source

pub fn cursor(&self) -> &C

The cursor/metadata value restored with this state.

Source

pub fn byte_size(&self) -> usize

The retained byte-size this entry contributes to the stack’s size cap — the length of the snapshot’s source_text in bytes (TR-024).

The CST snapshot itself is structurally shared and is not counted here; the source text is the dominant, deterministic per-unit cost.

Trait Implementations§

Source§

impl<C: Clone> Clone for UndoEntry<C>

Source§

fn clone(&self) -> UndoEntry<C>

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<C: Debug> Debug for UndoEntry<C>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<C> Freeze for UndoEntry<C>
where C: Freeze,

§

impl<C> RefUnwindSafe for UndoEntry<C>
where C: RefUnwindSafe,

§

impl<C> Send for UndoEntry<C>
where C: Send,

§

impl<C> Sync for UndoEntry<C>
where C: Sync,

§

impl<C> Unpin for UndoEntry<C>
where C: Unpin,

§

impl<C> UnsafeUnpin for UndoEntry<C>
where C: UnsafeUnpin,

§

impl<C> UnwindSafe for UndoEntry<C>
where C: UnwindSafe,

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> 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> 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 = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.