Struct Engine 

pub struct Engine { /* private fields */ }

Represents the current state of a document and all of its history

Implementations

impl Engine

pub fn new(initial_contents: Node<RopeInfo>) -> Engine

Create a new Engine with a single edit that inserts initial_contents if it is non-empty. It needs to be a separate commit rather than just part of the initial contents since any two Engines need a common ancestor in order to be mergeable.

pub fn empty() -> Engine

pub fn max_undo_group_id(&self) -> usize

Returns the largest undo group ID used so far

pub fn get_head_rev_id(&self) -> RevId

Get revision id of head revision.

pub fn get_head(&self) -> &Node<RopeInfo>

Get text of head revision.

pub fn get_rev(&self, rev: u64) -> Option<Node<RopeInfo>>

Get text of a given revision, if it can be found.

pub fn try_delta_rev_head( &self, base_rev: u64, ) -> Result<Delta<RopeInfo>, Error>

A delta that, when applied to base_rev, results in the current head. Returns an error if there is not at least one edit.

pub fn edit_rev( &mut self, priority: usize, undo_group: usize, base_rev: u64, delta: Delta<RopeInfo>, )

Create a new edit based on base_rev.

Panics

Panics if base_rev does not exist, or if delta is poorly formed.

pub fn try_edit_rev( &mut self, priority: usize, undo_group: usize, base_rev: u64, delta: Delta<RopeInfo>, ) -> Result<(), Error>

Attempts to apply a new edit based on the [Revision] specified by base_rev, Returning an Error if the Revision cannot be found.

pub fn undo(&mut self, groups: BTreeSet<usize>)

pub fn is_equivalent_revision(&self, base_rev: RevId, other_rev: RevId) -> bool

pub fn gc(&mut self, gc_groups: &BTreeSet<usize>)

pub fn merge(&mut self, other: &Engine)

Merge the new content from another Engine into this one with a CRDT merge

pub fn set_session_id(&mut self, session: (u64, u32))

When merging between multiple concurrently-editing sessions, each session should have a unique ID set with this function, which will make the revisions they create not have colliding IDs. For safety, this will panic if any revisions have already been added to the Engine.

Merge may panic or return incorrect results if session IDs collide, which is why they can be 96 bits which is more than sufficient for this to never happen.

Trait Implementations

impl Debug for Engine

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Engine

fn deserialize<__D>( __deserializer: __D, ) -> Result<Engine, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Engine

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.