Struct Canonical 

pub struct Canonical<'a, 'b, 'r, R, T> { /* private fields */ }

Canonical captures the state for finding the quorum between a set of Dids and their references, attempting to agree on a Git commit or tag.

Construction happens through Canonical::new, at which point you must use Canonical::find_objects so that the state has the set of Objects it must use for the quorum calculation.

At this point, the caller can either call Canonical::quorum to find the quorum, or modify the calculation by produce a CanonicalWithConvergence using Canonical::with_convergence, and then using CanonicalWithConvergence::quorum.

Implementations

impl<'a, 'b, 'r, R> Canonical<'a, 'b, 'r, R, Initial>

where R: Ancestry + FindMergeBase + FindObjects,

pub fn new( refname: Qualified<'a>, rule: &'b Rule<ResolvedDelegates, Threshold>, repo: &'r R, ) -> Canonical<'a, 'b, 'r, R, Initial>

Construct a new Canonical with the given Qualified reference, a canonical reference ValidRule for that reference, and the Git repository to load and check the Git data.

pub fn find_objects( self, ) -> Result<Canonical<'a, 'b, 'r, R, ObjectsFound>, FindObjectsError>

Find the objects for the Canonical computation, and prepare it to find the quorum.

impl<'a, 'b, 'r, R> Canonical<'a, 'b, 'r, R, ObjectsFound>

where R: Ancestry + FindMergeBase + FindObjects,

pub fn with_convergence( self, candidate: Did, object: Object, ) -> CanonicalWithConvergence<'a, 'b, 'r, R>

Adds the check for convergence before finding the quorum.

pub fn quorum(self) -> Result<Quorum<'a>, QuorumError>

Find the Quorum for the canonical computation.

pub fn missing(&self) -> &Missing

If there are Missing objects, these may be reported by the caller, and if further objects are found, then these can be marked using Canonical::found_objects.

pub fn found_objects( &mut self, objects: impl IntoIterator<Item = (Did, Object)>, )

Mark the objects provided as found, removing them from the Missing set.

Trait Implementations

impl<'a, 'b, 'r, R> AsRef<Canonical<'a, 'b, 'r, R, ObjectsFound>> for CanonicalWithConvergence<'a, 'b, 'r, R>

fn as_ref(&self) -> &Canonical<'a, 'b, 'r, R, ObjectsFound>

Converts this type into a shared reference of the (usually inferred) input type.

impl<'a, 'b, 'r, R, T> Debug for Canonical<'a, 'b, 'r, R, T>

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

Formats the value using the given formatter.