Struct openraft::metrics::Wait

pub struct Wait<NID, N>where
    NID: NodeId,
    N: Node,{
    pub timeout: Duration,
    pub rx: Receiver<RaftMetrics<NID, N>>,
}

Wait is a wrapper of RaftMetrics channel that impls several utils to wait for metrics to satisfy some condition.

Fields

timeout: Duration

rx: Receiver<RaftMetrics<NID, N>>

Implementations

impl<NID, N> Wait<NID, N>where NID: NodeId, N: Node,

pub async fn metrics<T>( &self, func: T, msg: impl ToString ) -> Result<RaftMetrics<NID, N>, WaitError>where T: Fn(&RaftMetrics<NID, N>) -> bool + Send,

Wait for metrics to satisfy some condition or timeout.

pub async fn current_leader( &self, leader_id: NID, msg: impl ToString ) -> Result<RaftMetrics<NID, N>, WaitError>

Wait for current_leader to become Some(leader_id) until timeout.

pub async fn log( &self, want_log_index: Option<u64>, msg: impl ToString ) -> Result<RaftMetrics<NID, N>, WaitError>

Wait until applied exactly want_log(inclusive) logs or timeout.

pub async fn log_at_least( &self, want_log: Option<u64>, msg: impl ToString ) -> Result<RaftMetrics<NID, N>, WaitError>

Wait until applied at least want_log(inclusive) logs or timeout.

pub async fn state( &self, want_state: ServerState, msg: impl ToString ) -> Result<RaftMetrics<NID, N>, WaitError>

Wait for state to become want_state or timeout.

pub async fn members( &self, want_members: BTreeSet<NID>, msg: impl ToString ) -> Result<RaftMetrics<NID, N>, WaitError>

Wait for membership to become the expected node id set or timeout.

pub async fn snapshot( &self, want_snapshot: LogId<NID>, msg: impl ToString ) -> Result<RaftMetrics<NID, N>, WaitError>

Wait for snapshot to become want_snapshot or timeout.