RaftLog

Struct RaftLog 

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

In-memory log with persistent backing

Implementations§

Source§

impl RaftLog

Source

pub fn new() -> Self

Create a new empty log

Source

pub fn append(&mut self, term: Term, command: Command) -> LogIndex

Append a new entry to the log

Source

pub fn append_entries(&mut self, entries: Vec<LogEntry>) -> RaftResult<()>

Append multiple entries to the log

Source

pub fn get(&self, index: LogIndex) -> Option<&LogEntry>

Get an entry by index

Source

pub fn get_entries_from( &self, start_index: LogIndex, max_count: usize, ) -> Vec<LogEntry>

Get entries starting from a given index

Source

pub fn get_term(&self, index: LogIndex) -> Option<Term>

Get the term of an entry by index

Source

pub fn last_index(&self) -> LogIndex

Get the index of the last entry

Source

pub fn last_term(&self) -> Term

Get the term of the last entry

Source

pub fn truncate_from(&mut self, from_index: LogIndex) -> RaftResult<()>

Delete entries from a given index onwards

Source

pub fn matches(&self, index: LogIndex, term: Term) -> bool

Check if the log contains an entry at the given index with the given term

Source

pub fn commit_index(&self) -> LogIndex

Get the commit index

Source

pub fn set_commit_index(&mut self, index: LogIndex) -> RaftResult<()>

Set the commit index (must be monotonically increasing)

Source

pub fn applied_index(&self) -> LogIndex

Get the applied index

Source

pub fn set_applied_index(&mut self, index: LogIndex) -> RaftResult<()>

Set the applied index (must be monotonically increasing)

Source

pub fn get_uncommitted_entries(&self) -> Vec<LogEntry>

Get entries that are committed but not yet applied

Source

pub fn is_empty(&self) -> bool

Check if the log is empty

Source

pub fn len(&self) -> usize

Get the number of entries in the log

Trait Implementations§

Source§

impl Default for RaftLog

Source§

fn default() -> Self

Returns the “default value” for a type. 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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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, 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<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