Struct raft_engine::LogBatch

pub struct LogBatch { /* private fields */ }

A batch of log items.

Encoding format:

• header = { u56 len | u8 compression type | u64 item offset }
• entries = { [entry..] (optionally compressed) | crc32 }
• footer = { item batch }

Size restriction:

• The total size of log entries must not exceed 2GiB.

Error will be raised if a to-be-added log item cannot fit within those limits.

Implementations

impl LogBatch

pub fn with_capacity(cap: usize) -> Self

Creates a new, empty log batch capable of holding at least cap log items.

pub fn merge(&mut self, rhs: &mut Self) -> Result<()>

Moves all log items of rhs into Self, leaving rhs empty.

pub fn add_entries<M: MessageExt>(
    &mut self,
    region_id: u64,
    entries: &[M::Entry]
) -> Result<()>

Adds some protobuf log entries into the log batch.

pub fn add_command(&mut self, region_id: u64, cmd: Command)

Adds a command into the log batch.

pub fn delete(&mut self, region_id: u64, key: Vec<u8>)

Removes a key value pair from the log batch.

pub fn put_message<S: Message>(
    &mut self,
    region_id: u64,
    key: Vec<u8>,
    s: &S
) -> Result<()>

Adds a protobuf key value pair into the log batch.

pub fn put(&mut self, region_id: u64, key: Vec<u8>, value: Vec<u8>)

Adds a key value pair into the log batch.

pub fn is_empty(&self) -> bool

Returns true if the log batch contains no log item.

pub fn approximate_size(&self) -> usize

Returns approximate encoded size of this log batch. Might be larger than the actual size.

Trait Implementations

impl Clone for LogBatch

fn clone(&self) -> LogBatch

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LogBatch

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

Formats the value using the given formatter.

impl Default for LogBatch

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq<LogBatch> for LogBatch

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl ReactiveBytes for LogBatch

fn as_bytes(&mut self, ctx: &LogFileContext) -> &[u8]

impl Eq for LogBatch

impl StructuralEq for LogBatch

impl StructuralPartialEq for LogBatch