Struct Transform 

pub struct Transform { /* private fields */ }

An accumulating, invertible batch of document changes.

Implementations

impl Transform

pub fn new(doc: Node) -> Self

Start a transform from doc.

pub fn doc(&self) -> &Node

The current document (after the steps applied so far).

pub fn steps(&self) -> &[Box<dyn Step>]

The steps applied so far.

pub fn doc_before(&self, i: usize) -> &Node

The document before step i.

pub fn mapping(&self) -> &Mapping

The combined position mapping for all steps so far.

pub fn doc_changed(&self) -> bool

Whether any step has been applied.

pub fn step( &mut self, step: Box<dyn Step>, schema: &Schema, ) -> Result<&mut Self, StepError>

Apply step, recording the prior document and its map.

pub fn replace( &mut self, from: usize, to: usize, slice: Slice, schema: &Schema, ) -> Result<&mut Self, StepError>

Replace from..to with slice.

pub fn delete( &mut self, from: usize, to: usize, schema: &Schema, ) -> Result<&mut Self, StepError>

Delete from..to.

pub fn insert( &mut self, pos: usize, slice: Slice, schema: &Schema, ) -> Result<&mut Self, StepError>

Insert slice at pos.

pub fn add_mark( &mut self, from: usize, to: usize, mark: Mark, schema: &Schema, ) -> Result<&mut Self, StepError>

Add mark across from..to.

pub fn remove_mark( &mut self, from: usize, to: usize, mark: Mark, schema: &Schema, ) -> Result<&mut Self, StepError>

Remove mark across from..to.

pub fn split( &mut self, pos: usize, schema: &Schema, ) -> Result<&mut Self, StepError>

Split the textblock at pos into two blocks of the same type (depth-1 split — the common Enter behaviour).

pub fn split_at_depth( &mut self, pos: usize, levels: usize, schema: &Schema, ) -> Result<&mut Self, StepError>

Split at pos all the way up to levels ancestors (so levels = 1 is the regular textblock split, levels = 2 splits a list_item + its paragraph, etc.). The split inserts levels pairs of (close, open) at pos; everything before stays in the first copy of each wrapper, everything after moves into the second.

pub fn set_node_attr( &mut self, pos: usize, attr: &str, value: Value, schema: &Schema, ) -> Result<&mut Self, StepError>

Set attribute attr to value on the node at pos.

pub fn invert_steps(&self) -> Result<Vec<Box<dyn Step>>, StepError>

Invert every step (last-first) against the document it applied to, yielding the steps that undo this whole transform.

Trait Implementations

impl Clone for Transform

fn clone(&self) -> Transform

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Transform

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

Formats the value using the given formatter.