Struct simple_raft::log::mem::RaftLogMemory

pub struct RaftLogMemory { /* fields omitted */ }

A naive in-memory implementation of RaftLog, primarily for testing.

Implementations

impl RaftLogMemory

pub fn new_unbounded() -> Self

Constructs an empty Raft log with unbounded capacity.

pub fn with_capacity(
    initial_entries_capacity: usize,
    data_capacity: usize
) -> Self

Constructs an empty Raft log with bounded capacity.

initial_entries_capacity specifies how many log entries the Raft log will be able to store without reallocating. data_capacity specifies the maximum size of log entry data to store before discarding entries from the beginning of the log.

Trait Implementations

impl RaftLog for RaftLogMemory

type Error = ()

The type of error returned by fallable operations.

fn append(&mut self, log_entry: LogEntry) -> Result<(), Self::Error>

Appends an entry to the end of the log.

fn cancel_from(&mut self, from_log_idx: LogIndex) -> Result<usize, ()>

Cancels all entries including and after the entry at index from_index, removing them from the log. Returns the number of entries removed.

fn entry_len(&self, log_entry: &LogEntry) -> usize

Returns the approximate serialized length in bytes of a given log entry.

fn get(&mut self, log_idx: LogIndex) -> Option<LogEntry>

Returns the entry at a given index, or None if the index is greater than the length of the log or if the entry has been discarded.

fn get_term(&mut self, log_idx: LogIndex) -> Option<TermId>

Returns the term of the entry at a given index, or None if the index is greater than the length of the log or if the entry has been discarded.

fn prev_index(&self) -> LogIndex

Returns the index immediately before the index of the first undiscarded entry in the log (see “Log Truncation”).

fn last_index(&self) -> LogIndex

Returns the index of the last entry in the log, or LogIndex::default() if empty.

fn last_taken_index(&self) -> LogIndex

Returns the index of the last entry which has been returned by take_next, or LogIndex::default() if none have been.

fn last_term(&self) -> TermId

Returns the term of the last entry in the log, or TermId::default() if empty.

fn prev_term(&self) -> TermId

Returns the term of the entry immediately preceding the first undiscarded entry in the log (see “Log Truncation”).

fn take_next(&mut self) -> Option<LogEntry>

Returns the next entry in the log not previously returned by this function, marking the returned entry eligible for future discard (see “Log Truncation”). Returns None if there is no such entry.

fn get_len(&mut self, index: LogIndex) -> Option<usize>

Returns the approximate serialized length of the entry at a given index, or None if the index is greater than the length of the log or if the entry has been discarded.