Struct UndoLog 

pub struct UndoLog { /* private fields */ }

A document’s undo, as one window drives it. See the module docs.

Implementations

impl UndoLog

pub fn new(doc: &mut AutoCommit) -> UndoLog

A history over doc as it stands. The current heads become the baseline the next step brackets against, so content already in the document is not attributed to a step nobody took here.

pub fn revision(&self) -> u64

A counter that changes whenever the history this window drives moves, and never otherwise: the cheap “did anything change?” test for an Undo control.

pub fn rebase(&mut self, doc: &mut AutoCommit)

Re-baseline against the document’s current heads: what a merge of remote changes needs, so the next local step brackets against the merged picture. A step open before the merge ends at it.

pub fn next_undo_as( &self, doc: &AutoCommit, author: Option<&UserId>, ) -> Option<UndoEntry>

The step a Ctrl+Z by author would take back, without taking it back. With an author, other people’s steps are walked past; without one, any step of this session.

pub fn next_redo_as( &self, doc: &AutoCommit, author: Option<&UserId>, ) -> Option<UndoEntry>

The undo a Ctrl+Shift+Z by author would bring back. The entry brackets the undo change; the caret is where it was when the undo was taken.

pub fn can_undo_as(&self, doc: &AutoCommit, author: Option<&UserId>) -> bool

Whether author has anything to undo — true exactly when undo_as would take a step back.

pub fn can_redo_as(&self, doc: &AutoCommit, author: Option<&UserId>) -> bool

Whether author has anything to redo.

pub fn peek_last_undo(&self, doc: &AutoCommit) -> Option<UndoEntry>

The newest step of this session in effect, whoever made it.

pub fn undo_depth(&self, doc: &AutoCommit) -> usize

How many steps of this session are in effect, whoever made them.

pub fn redo_depth(&self, doc: &AutoCommit) -> usize

How many undos of this session redo can bring back.

pub fn commit_action_authored( &mut self, doc: &mut AutoCommit, focused_node_idx: Option<usize>, metadata: Option<String>, author: Option<UserId>, ) -> bool

Commit doc’s open transaction as a step, bracketed from the last boundary. Returns true iff this committed a change (there were pending ops). false means the transaction was empty — the caller can then skip any persistence / broadcast work.

pub fn commit_action_authored_with_message( &mut self, doc: &mut AutoCommit, focused_node_idx: Option<usize>, metadata: Option<String>, author: Option<UserId>, message: Option<String>, ) -> bool

As Self::commit_action_authored, with the entry of native CRDT edits that deliberately do not travel through an action envelope (for example, co-edited flowing text).

pub fn record_committed_action( &mut self, doc: &mut AutoCommit, before: Vec<ChangeHash>, focused_node_idx: Option<usize>, metadata: Option<String>, ) -> bool

Record a step already committed into doc out of band (an action the palette dispatched, which owns its own commit boundary), bracketed by before. Unattributed: an author-scoped Ctrl+Z of this session claims it.

pub fn record_committed_action_authored( &mut self, doc: &mut AutoCommit, before: Vec<ChangeHash>, focused_node_idx: Option<usize>, metadata: Option<String>, author: Option<UserId>, ) -> bool

As Self::record_committed_action, naming who performed it — for a change that reached this document from outside the window (an agent, a collaborator’s published operation) under the caller’s own actor. The name keeps the steps apart afterwards.

pub fn record_committed_action_in( &mut self, doc: &mut AutoCommit, before: Vec<ChangeHash>, focused_node_idx: Option<usize>, metadata: Option<String>, author: UserId, instance: u64, ) -> bool

Record a bound action of one window instance.

pub fn undo_as( &mut self, doc: &mut AutoCommit, author: Option<&UserId>, focus: Option<usize>, metadata: Option<String>, registry: Option<&ActionRegistry>, ) -> Option<UndoEntry>

Take back the step author would undo (see State::undo_as).

pub fn redo_as( &mut self, doc: &mut AutoCommit, author: Option<&UserId>, focus: Option<usize>, metadata: Option<String>, registry: Option<&ActionRegistry>, ) -> Option<UndoEntry>

Bring back the undo author would redo.

pub fn next_undo_in( &self, doc: &AutoCommit, author: &UserId, instance: u64, ) -> Option<UndoEntry>

The step author’s window instance would undo.

pub fn next_redo_in( &self, doc: &AutoCommit, author: &UserId, instance: u64, ) -> Option<UndoEntry>

The undo author’s window instance would redo.

pub fn undo_in( &mut self, doc: &mut AutoCommit, author: &UserId, instance: u64, focus: Option<usize>, metadata: Option<String>, registry: Option<&ActionRegistry>, ) -> Option<UndoEntry>

Take back the step author’s window instance would undo.

pub fn redo_in( &mut self, doc: &mut AutoCommit, author: &UserId, instance: u64, focus: Option<usize>, metadata: Option<String>, registry: Option<&ActionRegistry>, ) -> Option<UndoEntry>

Bring back the undo author’s window instance would redo.

pub fn restore_to_heads( &mut self, doc: &mut AutoCommit, target_heads: &[ChangeHash], focused_node_idx: Option<usize>, metadata: Option<String>, author: Option<UserId>, ) -> bool

See State::restore_to_heads.

pub fn restore_to_heads_with_message( &mut self, doc: &mut AutoCommit, target_heads: &[ChangeHash], focused_node_idx: Option<usize>, metadata: Option<String>, author: Option<UserId>, message: Option<String>, ) -> bool

See State::restore_to_heads_with_context.

pub fn restore_to_heads_in( &mut self, doc: &mut AutoCommit, target_heads: &[ChangeHash], focused_node_idx: Option<usize>, metadata: Option<String>, author: UserId, instance: u64, ) -> bool

Trait Implementations

impl Default for UndoLog

fn default() -> UndoLog

A history with no baseline yet, for a holder that swaps a document’s own in and out.