Struct RecoveryReader 

pub struct RecoveryReader { /* private fields */ }

Streaming RecoverySlice reader for one recovery set, accumulating rows across volumes under a RecoveryBudget.

Rows are held in the order their packets were read. When the budget is full, a new row is kept only if its exponent is lower than the highest one held, which is then dropped. Peak memory is one slice over the budget.

Implementations

impl RecoveryReader

pub fn new(set_id: [u8; 16], slice_size: u64) -> Self

Reader for recovery set set_id with slices of slice_size bytes, an unlimited budget and the DEFAULT_MAX_VOLUME_BYTES cap.

pub fn with_budget(self, budget: RecoveryBudget) -> Self

Set the budget (builder form of set_budget).

pub fn with_max_volume_bytes(self, max: u64) -> Self

Cap the bytes read from one volume. A volume longer than this reports VolumeEnd::CapReached.

pub fn set_budget(&mut self, budget: RecoveryBudget)

Change the budget. Shrinking it drops the highest-exponent rows now.

pub fn row_limit(&self) -> usize

Current row limit.

pub fn seen(&self) -> usize

Intact RecoverySlice packets for this set seen across all volumes.

pub fn kept(&self) -> usize

Rows held now.

pub fn blocks(&self) -> &[RecoveryBlock]

Rows held, in packet order.

pub fn into_blocks(self) -> Vec<RecoveryBlock>

Take the held rows, in packet order.

pub fn read_volume<R: Read>(&mut self, reader: R) -> VolumeScan

Read RecoverySlice packets from one volume.

Packets for other sets, other packet types and rows outside the budget are read past without being buffered. Never fails: how the read ended is in VolumeScan::end, and rows found before a failure are kept.

Trait Implementations

impl Clone for RecoveryReader

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RecoveryReader

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

Formats the value using the given formatter.