Struct openraft_memstore::MemStore

pub struct MemStore { /* private fields */ }

An in-memory storage system implementing the RaftStorage trait.

Implementations

impl MemStore

pub async fn new() -> Self

Create a new MemStore instance. TODO(xp): creating a store should not require an id.

Trait Implementations

impl RaftStorage<ClientRequest, ClientResponse> for MemStore

type SnapshotData = Cursor<Vec<u8, Global>>

The storage engine’s associated type used for exposing a snapshot for reading & writing.

fn save_hard_state<'life0, 'life1, 'async_trait>(
    &'life0 self,
    hs: &'life1 HardState
) -> Pin<Box<dyn Future<Output = Result<(), StorageError>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait,

fn read_hard_state<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Result<Option<HardState>, StorageError>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    Self: 'async_trait,

fn try_get_log_entries<'life0, 'async_trait, RB>(
    &'life0 self,
    range: RB
) -> Pin<Box<dyn Future<Output = Result<Vec<Entry<ClientRequest>>, StorageError>> + Send + 'async_trait>>where
    RB: 'async_trait + RangeBounds<u64> + Clone + Debug + Send + Sync,
    'life0: 'async_trait,
    Self: 'async_trait,

Get a series of log entries from storage.

fn get_log_state<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Result<LogState, StorageError>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    Self: 'async_trait,

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

fn last_applied_state<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Result<(Option<LogId>, Option<EffectiveMembership>), StorageError>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    Self: 'async_trait,

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

fn delete_conflict_logs_since<'life0, 'async_trait>(
    &'life0 self,
    log_id: LogId
) -> Pin<Box<dyn Future<Output = Result<(), StorageError>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    Self: 'async_trait,

Delete conflict log entries since log_id, inclusive.

fn purge_logs_upto<'life0, 'async_trait>(
    &'life0 self,
    log_id: LogId
) -> Pin<Box<dyn Future<Output = Result<(), StorageError>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    Self: 'async_trait,

Delete applied log entries upto log_id, inclusive.

fn append_to_log<'life0, 'life1, 'life2, 'async_trait>(
    &'life0 self,
    entries: &'life1 [&'life2 Entry<ClientRequest>]
) -> Pin<Box<dyn Future<Output = Result<(), StorageError>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    Self: 'async_trait,

Append a payload of entries to the log.

fn apply_to_state_machine<'life0, 'life1, 'life2, 'async_trait>(
    &'life0 self,
    entries: &'life1 [&'life2 Entry<ClientRequest>]
) -> Pin<Box<dyn Future<Output = Result<Vec<ClientResponse>, StorageError>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    Self: 'async_trait,

Apply the given payload of entries to the state machine.

fn build_snapshot<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Result<Snapshot<Self::SnapshotData>, StorageError>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    Self: 'async_trait,

Build snapshot

fn begin_receiving_snapshot<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Result<Box<Self::SnapshotData>, StorageError>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    Self: 'async_trait,

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

fn install_snapshot<'life0, 'life1, 'async_trait>(
    &'life0 self,
    meta: &'life1 SnapshotMeta,
    snapshot: Box<Self::SnapshotData>
) -> Pin<Box<dyn Future<Output = Result<StateMachineChanges, StorageError>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait,

Install a snapshot which has finished streaming from the cluster leader.

fn get_current_snapshot<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Result<Option<Snapshot<Self::SnapshotData>>, StorageError>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    Self: 'async_trait,

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

impl RaftStorageDebug<MemStoreStateMachine> for MemStore

fn get_state_machine<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = MemStoreStateMachine> + Send + 'async_trait>>where
    'life0: 'async_trait,
    Self: 'async_trait,

Get a handle to the state machine for testing purposes.