Struct raft_log_engine::RaftLogEngine

[+] Show declaration

pub struct RaftLogEngine(RawRaftEngine<Entry, EntryExtTyped>);

Implementations

impl RaftLogEngine[−]

pub fn new(config: RaftEngineConfig) -> Self

pub fn exists(path: &str) -> bool[−]

If path is not an empty directory, we say db exists.

pub fn raft_groups(&self) -> Vec<u64>

pub fn first_index(&self, raft_id: u64) -> Option<u64>

pub fn last_index(&self, raft_id: u64) -> Option<u64>

Trait Implementations

impl Clone for RaftLogEngine[+]

[+] Show hidden undocumented items

fn clone(&self) -> RaftLogEngine[−]

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl RaftEngine for RaftLogEngine[+]

[+] Show hidden undocumented items

type LogBatch = RaftLogBatch

fn log_batch(&self, _capacity: usize) -> Self::LogBatch

fn sync(&self) -> Result<()>[−]

Synchronize the Raft engine.

fn get_raft_state(&self, raft_group_id: u64) -> Result<Option<RaftLocalState>>

fn get_entry(&self, raft_group_id: u64, index: u64) -> Result<Option<Entry>>

fn fetch_entries_to(
    &self,
    raft_group_id: u64,
    begin: u64,
    end: u64,
    max_size: Option<usize>,
    to: &mut Vec<Entry>
) -> Result<usize>[−]

Return count of fetched entries.

fn consume(&self, batch: &mut Self::LogBatch, sync: bool) -> Result<usize>[−]

Consume the write batch by moving the content into the engine itself and return written bytes.

fn consume_and_shrink(
    &self,
    batch: &mut Self::LogBatch,
    sync: bool,
    _: usize,
    _: usize
) -> Result<usize>[−]

Like consume but shrink batch if need.

fn clean(
    &self,
    raft_group_id: u64,
    _: &RaftLocalState,
    batch: &mut RaftLogBatch
) -> Result<()>

fn append(&self, raft_group_id: u64, entries: Vec<Entry>) -> Result<usize>[−]

Append some log entries and return written bytes.

fn put_raft_state(
    &self,
    raft_group_id: u64,
    state: &RaftLocalState
) -> Result<()>

fn gc(&self, raft_group_id: u64, _from: u64, to: u64) -> Result<usize>[−]

Like cut_logs but the range could be very large. Return the deleted count. Generally, from can be passed in 0.

fn purge_expired_files(&self) -> Result<Vec<u64>>[−]

Purge expired logs files and return a set of Raft group ids which needs to be compacted ASAP.

fn has_builtin_entry_cache(&self) -> bool[−]

The RaftEngine has a builtin entry cache or not.

fn gc_entry_cache(&self, raft_group_id: u64, to: u64)[−]

GC the builtin entry cache.

fn flush_stats(&self) -> Option<CacheStats>[−]

Flush current cache stats.

fn stop(&self)

fn dump_stats(&self) -> Result<String>

pub fn flush_metrics(&self, _instance: &str)

pub fn reset_statistics(&self)