Struct Config 

pub struct Config<A> {
    pub address: A,
    pub initial_height: u64,
    pub timeout_values: TimeoutValues,
    pub history_depth: u64,
    pub wal_dir: PathBuf,
    /* private fields */
}

The configuration for the consensus engine.

Fields

address: A

The address of the validator.

initial_height: u64

The initial height.

timeout_values: TimeoutValues

The timeout configuration.

history_depth: u64

The number of completed heights to keep in memory.

wal_dir: PathBuf

The directory to store the write-ahead log.

Implementations

impl<A: Default> Config<A>

pub fn new(address: A) -> Self

Create a new consensus config with the default values for a single validator.

pub fn with_initial_height(self, height: u64) -> Self

Set the initial height.

pub fn with_timeout_values(self, timeout_values: TimeoutValues) -> Self

Set the timeout values.

pub fn with_history_depth(self, history_depth: u64) -> Self

Set the number of completed heights to keep in memory.

pub fn with_wal_dir(self, wal_dir: PathBuf) -> Self

Set the WAL directory.

Trait Implementations

impl<A: Clone> Clone for Config<A>

fn clone(&self) -> Config<A>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<A: Debug> Debug for Config<A>

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

Formats the value using the given formatter.

impl<A: Default> Default for Config<A>

fn default() -> Config<A>

Returns the “default value” for a type.