Struct radicle_cob::history::History

pub struct History { /* private fields */ }

The DAG of changes making up the history of a collaborative object.

Implementations

impl History

pub fn new(root: EntryId, graph: Dag<EntryId, Entry>) -> Self

Create a new history from a DAG. Panics if the root is not part of the graph.

pub fn new_from_root(root: Entry) -> Self

Create a new history from a root entry.

pub fn tips(&self) -> BTreeSet<Oid>

Get all the tips of the graph.

pub fn traverse<F, A>(&self, init: A, roots: &[EntryId], f: F) -> A

where F: for<'r> FnMut(A, &'r EntryId, &'r Entry) -> ControlFlow<A, A>,

A topological (parents before children) traversal of the dependency graph of this history. This is analagous to std::iter::Iterator::fold in that it folds every change into an accumulator value of type A. However, unlike fold the function f may prune branches from the dependency graph by returning ControlFlow::Break.

pub fn sorted<F>(&self, compare: F) -> impl Iterator<Item = &Entry>

where F: FnMut(&EntryId, &EntryId) -> Ordering,

Return a topologically-sorted list of history entries.

pub fn extend(&mut self, change: Entry)

Extend this history with a new entry.

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

Merge two histories.

pub fn len(&self) -> usize

Get the number of history entries.

pub fn is_empty(&self) -> bool

Check if the graph is empty.

pub fn graph(&self) -> &Dag<EntryId, Entry>

Get the underlying graph

pub fn root(&self) -> &Entry

Get the root entry.

pub fn children_of(&self, id: &EntryId) -> Vec<EntryId>

Get the children of the given entry.

Trait Implementations

impl Clone for History

fn clone(&self) -> History

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for History

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

Formats the value using the given formatter.

impl PartialEq for History

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for History