Struct spacetimedb_commitlog::Commit

pub struct Commit {
    pub min_tx_offset: u64,
    pub n: u16,
    pub records: Vec<u8>,
}

Entry type of a crate::Commitlog.

Fields

min_tx_offset: u64

The offset of the first record in this commit.

The offset starts from zero and is counted from the beginning of the entire log.

n: u16

The number of records in the commit.

records: Vec<u8>

A buffer of all records in the commit in serialized form.

Readers must bring their own crate::Decoder to interpret this buffer. n indicates how many records the buffer contains.

Implementations

impl Commit

pub const FRAMING_LEN: usize = 18usize

pub const CHECKSUM_ALGORITHM: u8 = 0u8

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

The range of transaction offsets contained in this commit.

pub fn encoded_len(&self) -> usize

Length in bytes of this commit when written to the log via Self::write.

pub fn write<W: Write>(&self, out: W) -> Result<()>

Serialize and write self to out.

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

Attempt to read one Commit 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, de: &D ) -> impl Iterator<Item = Result<Transaction<D::Record>, D::Error>> + '_

Trait Implementations

impl Debug for Commit

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

Formats the value using the given formatter.

impl Default for Commit

fn default() -> Commit

Returns the “default value” for a type.

impl PartialEq for Commit

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