Struct StateMachine 

pub struct StateMachine { /* private fields */ }

State machine wrapping ClusterMetadata

Implementations

impl StateMachine

pub fn new(snapshot_dir: impl Into<PathBuf>) -> Self

Create new state machine with a snapshot directory

pub fn new_default() -> Self

Create state machine for legacy callers (in-memory, temp dir for snapshots)

pub async fn metadata(&self) -> RwLockReadGuard<'_, ClusterMetadata>

Get current metadata (read-only)

pub async fn load_latest_snapshot(&self) -> Result<bool, StorageError<NodeId>>

Load the latest snapshot from disk (called during startup).

This avoids replaying the entire Raft log by restoring the most recent snapshot into the state machine.

Trait Implementations

impl Default for StateMachine

fn default() -> Self

Returns the “default value” for a type.

impl RaftSnapshotBuilder<TypeConfig> for StateMachine

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

Build snapshot

impl RaftStateMachine<TypeConfig> for StateMachine

type SnapshotBuilder = StateMachine

Snapshot builder type.

async fn applied_state( &mut self, ) -> Result<(Option<RaftLogId>, RaftStoredMembership), StorageError<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<RaftResponse>, StorageError<NodeId>>

where I: IntoIterator<Item = RaftEntry> + Send, I::IntoIter: Send,

Apply the given payload of entries to the state machine.

async fn begin_receiving_snapshot( &mut self, ) -> Result<Box<File>, StorageError<NodeId>>

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

async fn install_snapshot( &mut self, meta: &RaftSnapshotMeta, snapshot: Box<File>, ) -> Result<(), StorageError<NodeId>>

Install a snapshot which has finished streaming from the leader.

async fn get_current_snapshot( &mut self, ) -> Result<Option<RaftSnapshot>, StorageError<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.