Struct raftbare::Log

pub struct Log { /* private fields */ }

In-memory representation of a Node local log.

Implementations

impl Log

pub const fn new(snapshot_config: ClusterConfig, entries: LogEntries) -> Self

Makes a new Log instance with the given cluster configuration and entries.

Examples

use raftbare::{ClusterConfig, Log, LogEntries, LogEntry, LogPosition, NodeId, Term};

let empty_config = ClusterConfig::new();
let mut single_config = ClusterConfig::new();
single_config.voters.insert(NodeId::new(1));

let entries = LogEntries::from_iter(
    LogPosition::ZERO,
    vec![
        LogEntry::Term(Term::ZERO),
        LogEntry::ClusterConfig(single_config.clone()),
        LogEntry::Command,
    ],
);
let log = Log::new(empty_config.clone(), entries);

assert_eq!(log.snapshot_position(), LogPosition::ZERO);
assert_eq!(log.snapshot_config(), &empty_config);
assert_eq!(log.latest_config(), &single_config);

pub fn entries(&self) -> &LogEntries

Returns a reference to the entries in this log.

pub fn last_position(&self) -> LogPosition

Returns the position of the last entry in this log.

This is equivalent to self.entries().last_position().

pub fn snapshot_position(&self) -> LogPosition

Returns the log position where the snapshot was taken.

This is equivalent to self.entries().prev_position().

pub fn snapshot_config(&self) -> &ClusterConfig

Returns a reference to the cluster configuration at the time the snapshot was taken.

pub fn latest_config(&self) -> &ClusterConfig

Returns a reference to the cluster configuration located at the highest index in this log.

Trait Implementations

impl Clone for Log

fn clone(&self) -> Log

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Log

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for Log

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Log

fn eq(&self, other: &Log) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Log

impl StructuralPartialEq for Log