Struct Record 

pub struct Record { /* private fields */ }

One record read back during iteration: its Lsn and its payload bytes.

Yielded by Wal::iter. The payload is owned (a fresh Vec per record); take it without copying via into_data, or borrow it via data.

Implementations

impl Record

pub fn lsn(&self) -> Lsn

The sequence number this record was assigned — its byte offset in the log.

pub fn data(&self) -> &[u8]

The record’s payload bytes.

pub fn len(&self) -> usize

The payload length in bytes.

pub fn is_empty(&self) -> bool

Whether the record’s payload is empty.

pub fn into_data(self) -> Vec<u8>

Consume the record and take ownership of its payload without copying.

pub fn decode<T: Deserialize>(&self) -> Result<T>

Decode the record’s payload into a typed value via pack-io.

The mirror of Wal::append_typed. Available with the pack-io feature.

Errors

Returns WalError::Encoding if the bytes do not deserialise into T — for example reading a record written as a different type.

Examples

use wal_db::{MemStore, Wal};
use wal_db::pack_io::{Deserialize, Serialize};

#[derive(Serialize, Deserialize, PartialEq, Debug)]
struct Event {
    id: u64,
    name: String,
}

let wal = Wal::with_store(MemStore::new())?;
wal.append_typed(&Event { id: 7, name: "boot".into() })?;

let record = wal.iter()?.next().unwrap()?;
let event: Event = record.decode()?;
assert_eq!(event, Event { id: 7, name: "boot".into() });

Trait Implementations

impl Clone for Record

fn clone(&self) -> Record

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Record

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

Formats the value using the given formatter.

impl Eq for Record

impl PartialEq for Record

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