Struct TypeConfig 

pub struct TypeConfig {}

Declare the type configuration for example K/V store.

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 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 NetBackoff<TypeConfig> for NetworkConnection

fn backoff(&self) -> Backoff

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

impl NetSnapshot<TypeConfig> for NetworkConnection

async fn full_snapshot( &mut self, vote: <TypeConfig as RaftTypeConfig>::Vote, snapshot: Snapshot<TypeConfig>, _cancel: impl Future<Output = ReplicationClosed> + OptionalSend + 'static, _option: RPCOption, ) -> Result<SnapshotResponse<TypeConfig>, StreamingError<TypeConfig>>

Send a complete Snapshot to the target.

impl NetStreamAppend<TypeConfig> for NetworkConnection

fn stream_append<'s, S>( &'s mut self, input: S, _option: RPCOption, ) -> BoxFuture<'s, Result<BoxStream<'s, Result<StreamAppendResult<TypeConfig>, RPCError<TypeConfig, Infallible>>>, RPCError<TypeConfig, Infallible>>>

where S: Stream<Item = AppendEntriesRequest<TypeConfig>> + OptionalSend + Unpin + 'static,

Send a stream of AppendEntries RPCs to the target and return a stream of responses.

impl NetTransferLeader<TypeConfig> for NetworkConnection

async fn transfer_leader( &mut self, _req: TransferLeaderRequest<TypeConfig>, _option: RPCOption, ) -> Result<(), RPCError<TypeConfig, Infallible>>

Send TransferLeader message to the target node.

impl NetVote<TypeConfig> for NetworkConnection

async fn vote( &mut self, req: VoteRequest<TypeConfig>, _option: RPCOption, ) -> Result<VoteResponse<TypeConfig>, RPCError<TypeConfig, Infallible>>

Send a RequestVote RPC to the target.

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 RaftEntry<TypeConfig> for Entry

fn new(log_id: LogIdOf<TypeConfig>, payload: EntryPayload<TypeConfig>) -> Self

Create a new log entry with log id and payload of application data or membership config.

fn log_id_parts(&self) -> (&u64, u64)

Returns references to the components of this entry’s log ID: the committed leader ID and index.

fn set_log_id(&mut self, new: LogIdOf<TypeConfig>)

Set the log ID of this entry.

fn new_blank(log_id: LogId<C>) -> Self

where Self: Sized + Final,

Create a new blank log entry.

fn new_normal(log_id: LogId<C>, data: <C as RaftTypeConfig>::D) -> Self

where Self: Sized + Final,

Create a new normal log entry that contains application data.

fn new_membership(log_id: LogId<C>, m: Membership<C>) -> Self

where Self: Sized + Final,

Create a new membership log entry.

fn log_id(&self) -> LogId<C>

where Self: Final,

Returns the LogId of this entry.

fn index(&self) -> u64

where Self: Final,

Returns the index of this log entry.

impl RaftLeaderId<TypeConfig> for LeaderId

type Committed = u64

The committed version of this leader ID.

fn new(term: u64, node_id: u64) -> Self

Create a new leader ID for the given term and node.

fn term(&self) -> u64

Get the term number of this leader

fn node_id(&self) -> &u64

Get the node ID of this leader

fn to_committed(&self) -> Self::Committed

Convert this leader ID to a committed leader ID.

impl RaftNetworkFactory<TypeConfig> for Network

Implementation of the RaftNetworkFactory trait for creating new network connections. This factory creates gRPC client connections to other Raft nodes.

type Network = NetworkConnection

Actual type of the network handling a single connection.

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

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

impl RaftPayload<TypeConfig> for Entry

fn get_membership(&self) -> Option<Membership<TypeConfig>>

Return Some(Membership) if the entry payload contains a membership payload.

impl RaftSnapshotBuilder<TypeConfig> for Arc<FjallStateMachine>

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

Build snapshot

impl RaftStateMachine<TypeConfig> for Arc<FjallStateMachine>

type SnapshotBuilder = Arc<FjallStateMachine>

Snapshot builder type.

async fn applied_state( &mut self, ) -> Result<(Option<LogIdOf<TypeConfig>>, StoredMembership<TypeConfig>), Error>

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

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

Get the snapshot builder for the state machine.

async fn begin_receiving_snapshot( &mut self, ) -> Result<SnapshotDataOf<TypeConfig>, Error>

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

async fn install_snapshot( &mut self, meta: &SnapshotMeta<TypeConfig>, snapshot: SnapshotDataOf<TypeConfig>, ) -> Result<(), Error>

Install a snapshot which has finished streaming from the leader.

async fn get_current_snapshot( &mut self, ) -> Result<Option<Snapshot<TypeConfig>>, Error>

Get a readable handle to the current snapshot.

async fn apply<Strm>(&mut self, entries: Strm) -> Result<(), Error>

where Strm: Stream<Item = Result<EntryResponder<TypeConfig>, Error>> + Unpin + OptionalSend,

Apply the given payload of entries to the state machine.

fn try_create_snapshot_builder( &mut self, force: bool, ) -> impl Future<Output = Option<Self::SnapshotBuilder>> + Send

Try to create a snapshot builder for the state machine.

impl RaftTypeConfig for TypeConfig

type D = SetRequest

Application-specific request data passed to the state machine.

type R = Response

Application-specific response data returned by the state machine.

type LeaderId = LeaderId

A Leader identifier in a cluster.

type Vote = Vote

Raft vote type.

type Entry = Entry

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

type Node = Node

Raft application level node data

type SnapshotData = Vec<u8>

Snapshot data for exposing a snapshot for reading & writing.

type NodeId = u64

A Raft node’s ID.

type Term = u64

Type representing a Raft term number.

type Responder<T> = ProgressResponder<TypeConfig, T> where T: OptionalSend + 'static

Responder type for sending client write responses asynchronously.

type AsyncRuntime = TokioRuntime

Asynchronous runtime type.

type ErrorSource = BoxedErrorSource

Error wrapper type for storage and network errors.

impl RaftVote<TypeConfig> for Vote

fn from_leader_id( leader_id: <TypeConfig as RaftTypeConfig>::LeaderId, committed: bool, ) -> Self

Create a new vote for the specified leader with optional quorum commitment.

fn leader_id(&self) -> &<TypeConfig as RaftTypeConfig>::LeaderId

Get a reference to this vote’s LeaderId(RaftLeaderId implementation).

fn is_committed(&self) -> bool

Whether this vote has been committed by a quorum.

fn to_owned_vote(&self) -> Vote<C>

Convert to the openraft-provided Vote struct.

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

where V: RaftVote<C>,

Compare this vote with another vote by partial order.

impl Copy for TypeConfig

impl Eq for TypeConfig

impl StructuralPartialEq for TypeConfig