Struct CommitteeStore 

pub struct CommitteeStore<N, C>
where
    N: Network,
    C: CommitteeStorage<N>,
{ /* private fields */ }

The committee store.

Implementations

impl<N, C> CommitteeStore<N, C>

where N: Network, C: CommitteeStorage<N>,

pub fn open(dev: Option<u16>) -> Result<CommitteeStore<N, C>, Error>

Initializes the committee store.

pub fn from(storage: C) -> CommitteeStore<N, C>

Initializes a committee store from storage.

pub fn start_atomic(&self)

Starts an atomic batch write operation.

pub fn is_atomic_in_progress(&self) -> bool

Checks if an atomic batch is in progress.

pub fn atomic_checkpoint(&self)

Checkpoints the atomic batch.

pub fn clear_latest_checkpoint(&self)

Clears the latest atomic batch checkpoint.

pub fn atomic_rewind(&self)

Rewinds the atomic batch to the previous checkpoint.

pub fn abort_atomic(&self)

Aborts an atomic batch write operation.

pub fn finish_atomic(&self) -> Result<(), Error>

Finishes an atomic batch write operation.

pub fn dev(&self) -> Option<u16>

Returns the optional development ID.

impl<N, C> CommitteeStore<N, C>

where N: Network, C: CommitteeStorage<N>,

pub fn insert( &self, next_height: u32, committee: Committee<N>, ) -> Result<(), Error>

Stores the given (next height, committee) pair into storage, and indexes storage up to the next round.

pub fn remove(&self, height: u32) -> Result<(), Error>

Removes the committee for the given height, in the process removing all round to height entries back to the previous committee.

impl<N, C> CommitteeStore<N, C>

where N: Network, C: CommitteeStorage<N>,

pub fn current_round(&self) -> Result<u64, Error>

Returns the current round.

pub fn current_height(&self) -> Result<u32, Error>

Returns the current height.

pub fn current_committee(&self) -> Result<Committee<N>, Error>

Returns the current committee.

pub fn get_height_for_round(&self, round: u64) -> Result<Option<u32>, Error>

Returns the height for the given round.

pub fn get_committee(&self, height: u32) -> Result<Option<Committee<N>>, Error>

Returns the committee for the given height.

pub fn get_committee_for_round( &self, round: u64, ) -> Result<Option<Committee<N>>, Error>

Returns the committee for the given round.

Trait Implementations

impl<N, C> Clone for CommitteeStore<N, C>

where N: Clone + Network, C: Clone + CommitteeStorage<N>,

fn clone(&self) -> CommitteeStore<N, C>

Returns a duplicate of the value.

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

Performs copy-assignment from source.