Struct StoredCommit

pub struct StoredCommit {
    pub min_tx_offset: u64,
    pub epoch: u64,
    pub n: u16,
    pub records: Vec<u8>,
    pub checksum: u32,
}

A Commit as stored on disk.

Differs from Commit only in the presence of a checksum field, which is computed when encoding a commit for storage.

Fields

min_tx_offset: u64

See Commit::min_tx_offset.

epoch: u64

See Commit::epoch.

n: u16

See Commit::n.

records: Vec<u8>

See Commit::records.

checksum: u32

The checksum computed when encoding a Commit for storage.

Implementations

impl StoredCommit

pub fn tx_range(&self) -> Range<u64>

The range of transaction offsets contained in this commit.

pub fn decode<R: Read>(reader: R) -> Result<Option<Self>>

Attempt to read one StoredCommit from the given Reader.

Returns None if the reader is already at EOF.

Verifies the checksum of the commit. If it doesn’t match, an error of kind io::ErrorKind::InvalidData with an inner error downcastable to ChecksumMismatch is returned.

pub fn into_transactions<D: Decoder>( self, version: u8, from_offset: u64, de: &D, ) -> impl Iterator<Item = Result<Transaction<D::Record>, D::Error>> + '_

Convert self into an iterator yielding Transactions.

The supplied Decoder is responsible for extracting individual transactions from the records buffer.

Trait Implementations

impl Debug for StoredCommit

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

Formats the value using the given formatter.

impl From<StoredCommit> for Commit

fn from(_: StoredCommit) -> Self

Converts to this type from the input type.

impl PartialEq for StoredCommit

fn eq(&self, other: &StoredCommit) -> 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 StructuralPartialEq for StoredCommit