Struct WalBackendAdapter 

pub struct WalBackendAdapter<F: VfsFile> { /* private fields */ }

Implementations

impl<F: VfsFile> WalBackendAdapter<F>

pub fn new(wal: WalFile<F>) -> Self

Wrap an existing WalFile in the adapter (FEC disabled).

pub fn with_fec_hook(wal: WalFile<F>, hook: FecCommitHook) -> Self

Wrap an existing WalFile with an FEC commit hook.

pub fn into_inner(self) -> WalFile<F>

Consume the adapter and return the inner WalFile.

pub fn inner(&self) -> &WalFile<F>

Borrow the inner WalFile.

pub fn inner_mut(&mut self) -> &mut WalFile<F>

Mutably borrow the inner WalFile.

Invalidates the publication plane since the caller may mutate WAL state.

pub fn take_fec_pending(&mut self) -> Vec<FecCommitResult>

Take any pending FEC commit results for sidecar persistence.

pub fn fec_enabled(&self) -> bool

Whether FEC encoding is active.

pub fn fec_discard(&mut self)

Discard buffered FEC pages (e.g. on transaction rollback).

Trait Implementations

impl<F: VfsFile> WalBackend for WalBackendAdapter<F>

fn begin_transaction(&mut self, cx: &Cx) -> Result<()>

Prepare WAL state for a newly-started transaction.

fn append_frame( &mut self, cx: &Cx, page_number: u32, page_data: &[u8], db_size_if_commit: u32, ) -> Result<()>

Append a single frame to the WAL.

fn append_frames(&mut self, cx: &Cx, frames: &[WalFrameRef<'_>]) -> Result<()>

Append a batch of frames to the WAL.

fn prepare_append_frames( &mut self, frames: &[WalFrameRef<'_>], ) -> Result<Option<PreparedWalFrameBatch>>

Prepare a batch of frames for a later append.

fn finalize_prepared_frames( &mut self, _cx: &Cx, prepared: &mut PreparedWalFrameBatch, ) -> Result<()>

Optionally finalize a prepared batch before the serialized append.

fn append_prepared_frames( &mut self, cx: &Cx, prepared: &mut PreparedWalFrameBatch, ) -> Result<()>

Append a previously prepared frame batch.

fn read_page(&mut self, cx: &Cx, page_number: u32) -> Result<Option<Vec<u8>>>

Look up the latest version of a page in the current visible WAL snapshot.

fn committed_txns_since_page( &mut self, cx: &Cx, page_number: u32, ) -> Result<u64>

Count committed transactions that occur after the latest committed frame for page_number in the current visible WAL snapshot.

fn committed_txn_count(&mut self, cx: &Cx) -> Result<u64>

Count committed transactions visible in the current WAL snapshot.

fn sync(&mut self, cx: &Cx) -> Result<()>

Sync the WAL file to stable storage.

fn frame_count(&self) -> usize

Number of valid frames currently in the WAL.

fn checkpoint( &mut self, cx: &Cx, mode: CheckpointMode, writer: &mut dyn CheckpointPageWriter, backfilled_frames: u32, oldest_reader_frame: Option<u32>, ) -> Result<CheckpointResult>

Run a checkpoint to transfer frames from the WAL to the database.