Skip to main content

RaftStore

Struct RaftStore 

Source
pub struct RaftStore { /* private fields */ }
Expand description

The log and vote live in raft.db, the state machine is orch’s own database. Apply writes each entry and raft:applied in one transaction on orch.db, so a crash never applies an entry twice, and a log that runs ahead of the state is normal for Raft

Implementations§

Source§

impl RaftStore

Source

pub async fn open(raft_db: &Path, store: TaskStore) -> Result<Self>

Trait Implementations§

Source§

impl Clone for RaftStore

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl RaftLogReader<TypeConfig> for RaftStore

Source§

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

Get a series of log entries from storage. Read more
Source§

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. Read more
Source§

impl RaftSnapshotBuilder<TypeConfig> for RaftStore

Source§

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

Build snapshot Read more
Source§

impl RaftStorage<TypeConfig> for RaftStore

Source§

type LogReader = RaftStore

Log reader type.
Source§

type SnapshotBuilder = RaftStore

Snapshot builder type.
Source§

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

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

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

Source§

async fn save_committed( &mut self, committed: Option<LogId<NodeId>>, ) -> Result<(), StorageError<NodeId>>

Saves the last committed log id to storage. Read more
Source§

async fn read_committed( &mut self, ) -> Result<Option<LogId<NodeId>>, StorageError<NodeId>>

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

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

Returns the last deleted log id and the last log id. Read more
Source§

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

Get the log reader. Read more
Source§

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

Append a payload of entries to the log. Read more
Source§

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

Delete conflict log entries since log_id, inclusive. Read more
Source§

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

Delete applied log entries upto log_id, inclusive. Read more
Source§

async fn last_applied_state( &mut self, ) -> Result<(Option<LogId<NodeId>>, StoredMembership<NodeId, BasicNode>), 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_to_state_machine( &mut self, entries: &[Entry<TypeConfig>], ) -> Result<Vec<Reply>, 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, BasicNode>, 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<TypeConfig>>, StorageError<NodeId>>

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

Auto Trait Implementations§

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

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

Source§

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

Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + 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: Sized + 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<C, LR> RaftLogReaderExt<C> for LR
where C: RaftTypeConfig, LR: RaftLogReader<C>,

Source§

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

Try to get an log entry. Read more
Source§

fn get_log_entries<RB>( &mut self, range: RB, ) -> impl Future<Output = Result<Vec<<C as RaftTypeConfig>::Entry>, StorageError<<C as RaftTypeConfig>::NodeId>>> + Send

Get a series of log entries from storage. Read more
Source§

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

Get the log id of the entry at index.
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 = !

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

fn try_from(value: U) -> Result<T, !>

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