Struct chronofold::Chronofold

pub struct Chronofold<A: Author, T> { /* fields omitted */ }

A conflict-free replicated data structure for versioned sequences.

Terminology

A chronofold can be regarded either as a log of changes or as a sequence of elements. These two viewpoints require distinct terminology:

• A log index is a 0-based index in the log of changes. This indices are stable (i.e. they stay the same after edits), but are subjective for each author.
• An element is a visible (not yet deleted) value of type T.
• Log order refers to the chronological order in which changes were added to the log. This order is subjective for each author.
• Causal order refers to the order of the linked list.

Editing

You can edit a chronofold in two ways: Either by applying Ops, or by creating a Session which has a Vec-like API.

Indexing

Like Vec, the Chronofold type allows to access values by index, because it implements the Index trait. The same rules apply: out-of-bound indexes cause panics, and you can use get to check whether the index exists.

Implementations

impl<A: Author, T> Chronofold<A, T>

pub fn last_index(&self) -> Option<LogIndex>

Returns the index of the last log entry (in log order).

impl<A: Author, T> Chronofold<A, T>

pub fn iter(&self) -> impl Iterator<Item = (&T, LogIndex)>

Returns an iterator over elements and their log indices in causal order.

pub fn iter_range<R>(&self, range: R) -> impl Iterator<Item = (&T, LogIndex)> where
    R: RangeBounds<LogIndex>, 

Returns an iterator over elements and their log indices in causal order.

pub fn iter_elements(&self) -> impl Iterator<Item = &T>

Returns an iterator over elements in causal order.

pub fn iter_changes(&self) -> impl Iterator<Item = &Change<T>>

Returns an iterator over changes in log order.

impl<A: Author, T: Clone> Chronofold<A, T>

pub fn iter_ops<'a, R>(
    &'a self,
    range: R
) -> impl Iterator<Item = Op<A, T>> + 'a where
    R: RangeBounds<LogIndex> + 'a, 

Returns an iterator over ops in log order.

impl<A: Author, T: Clone> Chronofold<A, T>

pub fn version(&self) -> &Version<A>

Returns a vector clock representing the version of this chronofold.

pub fn iter_newer_ops<'a>(
    &'a self,
    version: &'a Version<A>
) -> impl Iterator<Item = Op<A, T>> + 'a

Returns an iterator over ops newer than the given version in log order.

impl<A: Author, T: Debug> Chronofold<A, T>

pub fn new() -> Self

Constructs a new, empty chronofold.

pub fn session(&mut self, author: A) -> Session<A, T>

Creates an editing session for a single author.

pub fn apply(&mut self, op: Op<A, T>) -> Result<(), ChronofoldError<A, T>>

Applies an op to the chronofold.

pub fn is_empty(&self) -> bool

Returns true if the chronofold contains no elements.

pub fn len(&self) -> usize

Returns the number of elements in the chronofold.

pub fn get(&self, index: LogIndex) -> Option<&Change<T>>

Returns a reference to a change in the chronofold's log.

If index is out of bounds, None is returned.

Trait Implementations

impl<'_, A: Author, T> AsMut<Chronofold<A, T>> for Session<'_, A, T>

fn as_mut(&mut self) -> &mut Chronofold<A, T>

Performs the conversion.

impl<'_, A: Author, T> AsRef<Chronofold<A, T>> for Session<'_, A, T>

fn as_ref(&self) -> &Chronofold<A, T>

Performs the conversion.

impl<A: Clone + Author, T: Clone> Clone for Chronofold<A, T>

fn clone(&self) -> Chronofold<A, T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<A: Debug + Author, T: Debug> Debug for Chronofold<A, T>

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

Formats the value using the given formatter.

impl<A: Author, T> Default for Chronofold<A, T>

fn default() -> Self

Returns the "default value" for a type.

impl<A: Author, T: Display> Display for Chronofold<A, T>

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

Formats the value using the given formatter.

impl<A: Eq + Author, T: Eq> Eq for Chronofold<A, T>

impl<A: Author, T> Index<LogIndex> for Chronofold<A, T>

type Output = Change<T>

The returned type after indexing.

fn index(&self, index: LogIndex) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<A: PartialEq + Author, T: PartialEq> PartialEq<Chronofold<A, T>> for Chronofold<A, T>

fn eq(&self, other: &Chronofold<A, T>) -> bool

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

fn ne(&self, other: &Chronofold<A, T>) -> bool

This method tests for !=.

impl<A: Author, T> StructuralEq for Chronofold<A, T>

impl<A: Author, T> StructuralPartialEq for Chronofold<A, T>