Struct TypeConfig 

pub struct TypeConfig { /* private fields */ }

Trait Implementations

impl Clone for TypeConfig

fn clone(&self) -> TypeConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for TypeConfig

impl Debug for TypeConfig

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

Formats the value using the given formatter.

impl Default for TypeConfig

fn default() -> TypeConfig

Returns the “default value” for a type.

impl Eq for TypeConfig

impl Ord for TypeConfig

fn cmp(&self, other: &TypeConfig) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for TypeConfig

fn eq(&self, other: &TypeConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for TypeConfig

fn partial_cmp(&self, other: &TypeConfig) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl RaftLogReader<TypeConfig> for LogStorage<TypeConfig>

async fn try_get_log_entries<RB: RangeBounds<u64> + Clone + Debug + OptionalSend>( &mut self, range: RB, ) -> Result<Vec<<TypeConfig as RaftTypeConfig>::Entry>, StorageError<<TypeConfig as RaftTypeConfig>::NodeId>>

Get a series of log entries from storage.

fn limited_get_log_entries( &mut self, start: u64, end: u64, ) -> impl Future<Output = Result<Vec<<C as RaftTypeConfig>::Entry>, StorageError<<C as RaftTypeConfig>::NodeId>>> + Send

Returns log entries within range [start, end), end is exclusive, potentially limited by implementation-defined constraints.

impl RaftLogStorage<TypeConfig> for LogStorage<TypeConfig>

type LogReader = LogStorage

Log reader type.

async fn append<I>( &mut self, entries: I, callback: LogFlushed<TypeConfig>, ) -> Result<(), StorageError<<TypeConfig as RaftTypeConfig>::NodeId>>

where I: IntoIterator<Item = <TypeConfig as RaftTypeConfig>::Entry> + OptionalSend, I::IntoIter: OptionalSend,

Append log entries and call the callback once logs are persisted on disk.

async fn get_log_reader(&mut self) -> Self::LogReader

Get the log reader.

async fn get_log_state( &mut self, ) -> Result<LogState<TypeConfig>, StorageError<<TypeConfig as RaftTypeConfig>::NodeId>>

Returns the last deleted log id and the last log id.

async fn purge( &mut self, log_id: LogId<<TypeConfig as RaftTypeConfig>::NodeId>, ) -> Result<(), StorageError<<TypeConfig as RaftTypeConfig>::NodeId>>

Purge logs upto log_id, inclusive

async fn read_committed( &mut self, ) -> Result<Option<LogId<<TypeConfig as RaftTypeConfig>::NodeId>>, StorageError<<TypeConfig as RaftTypeConfig>::NodeId>>

Return the last saved committed log id by Self::save_committed.

async fn save_committed( &mut self, committed: Option<LogId<<TypeConfig as RaftTypeConfig>::NodeId>>, ) -> Result<(), StorageError<<TypeConfig as RaftTypeConfig>::NodeId>>

Saves the last committed log id to storage.

async fn read_vote( &mut self, ) -> Result<Option<Vote<<TypeConfig as RaftTypeConfig>::NodeId>>, StorageError<<TypeConfig as RaftTypeConfig>::NodeId>>

Return the last saved vote by Self::save_vote.

async fn save_vote( &mut self, vote: &Vote<<TypeConfig as RaftTypeConfig>::NodeId>, ) -> Result<(), StorageError<<TypeConfig as RaftTypeConfig>::NodeId>>

Save vote to storage.

async fn truncate( &mut self, log_id: LogId<<TypeConfig as RaftTypeConfig>::NodeId>, ) -> Result<(), StorageError<<TypeConfig as RaftTypeConfig>::NodeId>>

Truncate logs since log_id, inclusive

impl RaftNetwork<TypeConfig> for TcpNetwork

async fn vote( &mut self, rpc: VoteRequest<<TypeConfig as RaftTypeConfig>::NodeId>, _option: RPCOption, ) -> Result<VoteResponse<<TypeConfig as RaftTypeConfig>::NodeId>, RPCError<<TypeConfig as RaftTypeConfig>::NodeId, <TypeConfig as RaftTypeConfig>::Node, RaftError<<TypeConfig as RaftTypeConfig>::NodeId>>>

Send a RequestVote RPC to the target.

async fn append_entries( &mut self, rpc: AppendEntriesRequest<TypeConfig>, _option: RPCOption, ) -> Result<AppendEntriesResponse<<TypeConfig as RaftTypeConfig>::NodeId>, RPCError<<TypeConfig as RaftTypeConfig>::NodeId, <TypeConfig as RaftTypeConfig>::Node, RaftError<<TypeConfig as RaftTypeConfig>::NodeId>>>

Send an AppendEntries RPC to the target.

async fn install_snapshot( &mut self, rpc: InstallSnapshotRequest<TypeConfig>, _option: RPCOption, ) -> Result<InstallSnapshotResponse<<TypeConfig as RaftTypeConfig>::NodeId>, RPCError<<TypeConfig as RaftTypeConfig>::NodeId, <TypeConfig as RaftTypeConfig>::Node, RaftError<<TypeConfig as RaftTypeConfig>::NodeId, InstallSnapshotError>>>

Send an InstallSnapshot RPC to the target.

fn full_snapshot( &mut self, vote: Vote<<C as RaftTypeConfig>::NodeId>, snapshot: Snapshot<C>, cancel: impl Future<Output = ReplicationClosed> + OptionalSend + 'static, option: RPCOption, ) -> impl Future<Output = Result<SnapshotResponse<<C as RaftTypeConfig>::NodeId>, StreamingError<C, Fatal<<C as RaftTypeConfig>::NodeId>>>> + Send

Send a complete Snapshot to the target.

fn backoff(&self) -> Backoff

Build a backoff instance if the target node is temporarily(or permanently) unreachable.

impl RaftNetworkFactory<TypeConfig> for TcpNetworkService

type Network = TcpNetwork

Actual type of the network handling a single connection.

async fn new_client( &mut self, target: <TypeConfig as RaftTypeConfig>::NodeId, node: &<TypeConfig as RaftTypeConfig>::Node, ) -> Self::Network

Create a new network instance sending RPCs to the target node.

impl RaftSnapshotBuilder<TypeConfig> for Arc<StateMachineStore>

async fn build_snapshot( &mut self, ) -> Result<Snapshot<TypeConfig>, StorageError<NodeId>>

Build snapshot

impl RaftStateMachine<TypeConfig> for Arc<StateMachineStore>

type SnapshotBuilder = Arc<StateMachineStore>

Snapshot builder type.

async fn applied_state( &mut self, ) -> Result<(Option<LogId<<TypeConfig as RaftTypeConfig>::NodeId>>, StoredMembership<<TypeConfig as RaftTypeConfig>::NodeId, <TypeConfig as RaftTypeConfig>::Node>), StorageError<<TypeConfig as RaftTypeConfig>::NodeId>>

Returns the last applied log id which is recorded in state machine, and the last applied membership config.

async fn apply<I>( &mut self, entries: I, ) -> Result<Vec<<TypeConfig as RaftTypeConfig>::R>, StorageError<<TypeConfig as RaftTypeConfig>::NodeId>>

where I: IntoIterator<Item = <TypeConfig as RaftTypeConfig>::Entry> + OptionalSend, I::IntoIter: OptionalSend,

Apply the given payload of entries to the state machine.

async fn begin_receiving_snapshot( &mut self, ) -> Result<Box<<TypeConfig as RaftTypeConfig>::SnapshotData>, StorageError<<TypeConfig as RaftTypeConfig>::NodeId>>

Create a new blank snapshot, returning a writable handle to the snapshot object.

async fn get_current_snapshot( &mut self, ) -> Result<Option<Snapshot<TypeConfig>>, StorageError<<TypeConfig as RaftTypeConfig>::NodeId>>

Get a readable handle to the current snapshot.

async fn get_snapshot_builder(&mut self) -> Self::SnapshotBuilder

Get the snapshot builder for the state machine.

async fn install_snapshot( &mut self, meta: &SnapshotMeta<<TypeConfig as RaftTypeConfig>::NodeId, <TypeConfig as RaftTypeConfig>::Node>, snapshot: Box<<TypeConfig as RaftTypeConfig>::SnapshotData>, ) -> Result<(), StorageError<<TypeConfig as RaftTypeConfig>::NodeId>>

Install a snapshot which has finished streaming from the leader.

impl RaftTypeConfig for TypeConfig

type D = Proposal

Application-specific request data passed to the state machine.

type R = RaftResponse

Application-specific response data returned by the state machine.

type NodeId = NodeId

A Raft node’s ID.

type Node = TcpNode

Raft application level node data

type Entry = Entry<TypeConfig>

Raft log entry, which can be built from an AppData.

type SnapshotData = Cursor<Vec<u8>>

Snapshot data for exposing a snapshot for reading & writing.

type AsyncRuntime = TokioRuntime

Asynchronous runtime type.

type Responder = OneshotResponder<TypeConfig>

Send the response or error of a client write request(WriteResult).

impl StructuralPartialEq for TypeConfig