Struct Dump

pub struct Dump<T> { /* private fields */ }

A dump utility that reads WAL records from disk.

It acquires an exclusive lock on the directory to prevent concurrent writes while reading.

Implementations

impl<T: Types> Dump<T>

pub fn new(config: Arc<Config>) -> Result<Self, Error>

Creates a new Dump instance with the given configuration.

Errors

Returns an IO error if acquiring the directory lock fails.

Trait Implementations

impl<T: Types> DumpApi<T> for Dump<T>

fn write_with<D>(&self, write_record: D) -> Result<(), Error>

where D: FnMut(ChunkId, u64, Result<(Segment, WALRecord<T>), Error>) -> Result<(), Error>,

Reads all WAL records from disk and passes them to the provided callback function.

The callback receives:

• chunk_id: The ID of the chunk containing the record
• index: The 0-based index of the record within its chunk
• result: The result containing either the record data or an IO error

Errors

Returns an IO error if reading the chunks fails or if the callback returns an error.

fn write_to_string(&self) -> Result<String, Error>

Writes the Raft log contents to a String.

fn write<W: Write>(&self, w: W) -> Result<(), Error>

Writes the Raft log contents to the provided writer.