Skip to main content

MemStateMachine

Struct MemStateMachine 

Source
pub struct MemStateMachine<C, S, F>
where C: RaftTypeConfig<NodeId = NodeId>, S: Default + Clone + Serialize + DeserializeOwned + Send + Sync + 'static, F: Fn(&mut S, &C::D) -> C::R + Send + Sync + 'static,
{ /* private fields */ }
Expand description

In-memory Raft state machine (v2 API).

Generic over:

  • C: openraft RaftTypeConfig
  • S: application state type
  • F: a function fn(&mut S, &C::D) -> C::R that applies a log entry to the state.

The apply_fn approach keeps the state machine generic: the application provides a closure that knows how to mutate S given a log entry payload of type C::D.

Implementations§

Source§

impl<C, S, F> MemStateMachine<C, S, F>
where C: RaftTypeConfig<NodeId = NodeId>, S: Default + Clone + Serialize + DeserializeOwned + Send + Sync + 'static, F: Fn(&mut S, &C::D) -> C::R + Send + Sync + 'static,

Source

pub fn new(apply_fn: F) -> Self

Create a new state machine with the given apply function.

Source

pub fn data(&self) -> Arc<RwLock<SmData<C, S>>>

Get a read handle to the inner state machine data (for reading application state).

Trait Implementations§

Source§

impl<C, S, F> Clone for MemStateMachine<C, S, F>
where C: RaftTypeConfig<NodeId = NodeId>, S: Default + Clone + Serialize + DeserializeOwned + Send + Sync + 'static, F: Fn(&mut S, &C::D) -> C::R + Send + Sync + 'static,

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<C, S, F> RaftStateMachine<C> for MemStateMachine<C, S, F>
where C: RaftTypeConfig<NodeId = NodeId, SnapshotData = Cursor<Vec<u8>>, Entry = Entry<C>>, C::D: Clone + Serialize + DeserializeOwned, C::R: Default, S: Default + Clone + Serialize + DeserializeOwned + Send + Sync + 'static, F: Fn(&mut S, &C::D) -> C::R + Send + Sync + 'static,

Source§

type SnapshotBuilder = MemSnapshotBuilder<C, S, F>

Snapshot builder type.
Source§

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

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

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

Apply the given payload of entries to the state machine. Read more
Source§

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

Get the snapshot builder for the state machine. Read more
Source§

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

Create a new blank snapshot, returning a writable handle to the snapshot object. Read more
Source§

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

Install a snapshot which has finished streaming from the leader. Read more
Source§

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

Get a readable handle to the current snapshot. Read more

Auto Trait Implementations§

§

impl<C, S, F> Freeze for MemStateMachine<C, S, F>

§

impl<C, S, F> !RefUnwindSafe for MemStateMachine<C, S, F>

§

impl<C, S, F> Send for MemStateMachine<C, S, F>

§

impl<C, S, F> Sync for MemStateMachine<C, S, F>

§

impl<C, S, F> Unpin for MemStateMachine<C, S, F>

§

impl<C, S, F> UnsafeUnpin for MemStateMachine<C, S, F>

§

impl<C, S, F> !UnwindSafe for MemStateMachine<C, S, F>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> OptionalSend for T
where T: Send + ?Sized,

Source§

impl<T> OptionalSync for T
where T: Sync + ?Sized,