Struct TypeConfig 

pub struct TypeConfig;

Type configuration for openraft.

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<'de> Deserialize<'de> for TypeConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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 Arc<Storage>

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

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 RaftNetworkFactory<TypeConfig> for RaftNetworkFactory

type Network = RaftNetworkClient

Actual type of the network handling a single connection.

async fn new_client( &mut self, _target: u64, node: &BasicNode, ) -> RaftNetworkClient

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

impl RaftSnapshotBuilder<TypeConfig> for Arc<Storage>

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

Build snapshot

impl RaftStorage<TypeConfig> for Arc<Storage>

type LogReader = Arc<Storage>

Log reader type.

type SnapshotBuilder = Arc<Storage>

Snapshot builder type.

async fn get_log_state( &mut self, ) -> Result<LogState<TypeConfig>, StorageError<u64>>

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

async fn save_vote(&mut self, vote: &Vote<u64>) -> Result<(), StorageError<u64>>

To ensure correctness: the vote must be persisted on disk before returning.

async fn read_vote(&mut self) -> Result<Option<Vote<u64>>, StorageError<u64>>

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

Get the log reader.

async fn append_to_log<I>( &mut self, entries: I, ) -> Result<(), StorageError<u64>>

where I: IntoIterator<Item = Entry<TypeConfig>> + Send,

Append a payload of entries to the log.

async fn delete_conflict_logs_since( &mut self, log_id: LogId<u64>, ) -> Result<(), StorageError<u64>>

Delete conflict log entries since log_id, inclusive.

async fn purge_logs_upto( &mut self, log_id: LogId<u64>, ) -> Result<(), StorageError<u64>>

Delete applied log entries upto log_id, inclusive.

async fn last_applied_state( &mut self, ) -> Result<(Option<LogId<u64>>, StoredMembership<u64, BasicNode>), StorageError<u64>>

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

async fn apply_to_state_machine( &mut self, entries: &[Entry<TypeConfig>], ) -> Result<Vec<ClusterResponse>, StorageError<u64>>

Apply the given payload of entries to the state machine.

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<Box<Cursor<Vec<u8>>>, StorageError<u64>>

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

async fn install_snapshot( &mut self, meta: &SnapshotMeta<u64, BasicNode>, snapshot: Box<Cursor<Vec<u8>>>, ) -> Result<(), StorageError<u64>>

Install a snapshot which has finished streaming from the leader.

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

Get a readable handle to the current snapshot, along with its metadata.

fn save_committed( &mut self, _committed: Option<LogId<<C as RaftTypeConfig>::NodeId>>, ) -> impl Future<Output = Result<(), StorageError<<C as RaftTypeConfig>::NodeId>>> + Send

Saves the last committed log id to storage.

fn read_committed( &mut self, ) -> impl Future<Output = Result<Option<LogId<<C as RaftTypeConfig>::NodeId>>, StorageError<<C as RaftTypeConfig>::NodeId>>> + Send

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

impl RaftTypeConfig for TypeConfig

type D = ClusterCommand

Application-specific request data passed to the state machine.

type R = ClusterResponse

Application-specific response data returned by the state machine.

type Node = BasicNode

Raft application level node data

type NodeId = u64

A Raft node’s ID.

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 Serialize for TypeConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for TypeConfig

impl Eq for TypeConfig

impl StructuralPartialEq for TypeConfig