Struct CompactOptions 

pub struct CompactOptions {
    pub max_live_ratio: f64,
    pub max_pass_bytes: u64,
    pub relocate_chunk_bytes: usize,
    pub dry_run: bool,
    pub allow_consecutive: bool,
    pub allow_foreign_keys: bool,
}

Which objects compaction may rewrite, and how much it may do at once.

Fields

max_live_ratio: f64

Rewrite an object only if at most this much of it is still live. At 1.0 every live object is a candidate, which rewrites the whole container.

max_pass_bytes: u64

The most live bytes one pass rewrites. A pass is one checkpoint, so this is also what it holds dirty in memory until the flush — fs_relocate does not write anything out on its own. Objects are taken whole and cheapest first until the next would pass this; what is left waits for the next pass.

On a container that is not in the parted format a checkpoint is one object, so a pass is further capped at what one object can hold.

relocate_chunk_bytes: usize

How many bytes of blocks to hand fs_relocate at once. It holds what it reads in a buffer of its own before the dirty cache takes it, so this bounds that second copy.

dry_run: bool

Select and report, write nothing. No file is opened.

allow_consecutive: bool

Run even though the newest checkpoint is already a compaction. The flag that keeps content_cno still holds for one checkpoint only, so a second pass in a row is seen by consumers as a change of content. Set this when that is acceptable, for example to finish a container larger than one pass.

allow_foreign_keys: bool

Run even though the prefix holds keys this crate does not recognize. Only set this having established that they are not a WAL.

Trait Implementations

impl Clone for CompactOptions

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 CompactOptions

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

Formats the value using the given formatter.

impl Default for CompactOptions

fn default() -> Self

Returns the “default value” for a type.