Struct operational_transform::OperationSeq

pub struct OperationSeq { /* fields omitted */ }

A sequence of Operations on text.

Implementations

impl OperationSeq

pub fn with_capacity(capacity: usize) -> Self

Creates a store for operatations which does not need to allocate until capacity operations have been stored inside.

pub fn compose(&self, other: &Self) -> Result<Self, OTError>

Merges the operation with other into one operation while preserving the changes of both. Or, in other words, for each input string S and a pair of consecutive operations A and B. apply(apply(S, A), B) = apply(S, compose(A, B)) must hold.

Error

Returns an OTError if the operations are not composable due to length conflicts.

pub fn delete(&mut self, n: u64)

Deletes n characters at the current cursor position.

pub fn insert(&mut self, s: &str)

Inserts a s at the current cursor position.

pub fn retain(&mut self, n: u64)

Moves the cursor n characters forwards.

pub fn transform(&self, other: &Self) -> Result<(Self, Self), OTError>

Transforms two operations A and B that happened concurrently and produces two operations A' and B' (in an array) such that apply(apply(S, A), B') = apply(apply(S, B), A'). This function is the heart of OT.

Error

Returns an OTError if the operations cannot be transformed due to length conflicts.

pub fn apply(&self, s: &str) -> Result<String, OTError>

Applies an operation to a string, returning a new string.

Error

Returns an error if the operation cannot be applied due to length conflicts.

pub fn invert(&self, s: &str) -> Self

Computes the inverse of an operation. The inverse of an operation is the operation that reverts the effects of the operation, e.g. when you have an operation 'insert("hello "); skip(6);' then the inverse is 'delete("hello "); skip(6);'. The inverse should be used for implementing undo.

pub fn is_noop(&self) -> bool

Checks if this operation has no effect.

pub fn base_len(&self) -> usize

Returns the length of a string these operations can be applied to

pub fn target_len(&self) -> usize

Returns the length of the resulting string after the operations have been applied.

pub fn ops(&self) -> &[Operation]

Returns the wrapped sequence of operations.

Trait Implementations

impl Clone for OperationSeq

fn clone(&self) -> OperationSeq

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OperationSeq

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

Formats the value using the given formatter.

impl Default for OperationSeq

fn default() -> Self

Returns the "default value" for a type.

impl FromIterator<Operation> for OperationSeq

fn from_iter<T: IntoIterator<Item = Operation>>(ops: T) -> Self

Creates a value from an iterator.

impl PartialEq<OperationSeq> for OperationSeq

fn eq(&self, other: &OperationSeq) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &OperationSeq) -> bool

This method tests for !=.

impl StructuralPartialEq for OperationSeq