Struct bridgetree::Checkpoint

pub struct Checkpoint<C> { /* private fields */ }

A data structure used to store the information necessary to “rewind” the state of a BridgeTree to a particular leaf position.

This is needed because the BridgeTree::marked_indices map is a cache of information that crosses MerkleBridge boundaries, and so it is not sufficient to just truncate the list of bridges; instead, we use Checkpoint values to be able to rapidly restore the cache to its previous state.

Implementations

impl<C> Checkpoint<C>

pub fn from_parts( id: C, bridges_len: usize, marked: BTreeSet<Position>, forgotten: BTreeSet<Position> ) -> Self

Creates a new checkpoint from its constituent parts.

pub fn at_length(bridges_len: usize, id: C) -> Self

Creates a new empty checkpoint for the specified BridgeTree state.

pub fn id(&self) -> &C

The unique identifier for the checkpoint.

pub fn bridges_len(&self) -> usize

Returns the length of the BridgeTree::prior_bridges vector of the BridgeTree to which this checkpoint refers.

This is the number of bridges that will be retained in the event of a rewind to this checkpoint.

pub fn marked(&self) -> &BTreeSet<Position>

Returns a set of the positions that have been marked during the period that this checkpoint is the current checkpoint.

pub fn forgotten(&self) -> &BTreeSet<Position>

Returns the set of previously-marked positions that have had their marks removed during the period that this checkpoint is the current checkpoint.

Trait Implementations

impl<C: Clone> Clone for Checkpoint<C>

fn clone(&self) -> Checkpoint<C>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Debug> Debug for Checkpoint<C>

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

Formats the value using the given formatter.

impl<C: PartialEq> PartialEq<Checkpoint<C>> for Checkpoint<C>

fn eq(&self, other: &Checkpoint<C>) -> bool

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

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

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

impl<C: Eq> Eq for Checkpoint<C>

impl<C> StructuralEq for Checkpoint<C>

impl<C> StructuralPartialEq for Checkpoint<C>