Struct PruningOptions

pub struct PruningOptions {
    pruning_threshold: Option<u64>,
    minimum_retention: Option<Duration>,
    target_retention: Option<Duration>,
    batch_size: Option<u64>,
    max_usage: Option<u16>,
    interval: Option<Duration>,
    pages: Option<u64>,
}

Pruning parameters.

Fields

pruning_threshold: Option<u64>

Threshold for pruning, specified in bytes. If the disk usage surpasses this threshold, pruning is initiated for data older than the specified minimum retention period. Pruning continues until the disk usage drops below the MAX USAGE.

minimum_retention: Option<Duration>

Minimum retention period. Data is retained for at least this duration, even if there’s no free disk space.

target_retention: Option<Duration>

Target retention period. Data older than this is pruned to free up space.

batch_size: Option<u64>

Batch size for pruning. This is the number of blocks data to delete in a single transaction.

max_usage: Option<u16>

Maximum disk usage (in basis points).

Pruning stops once the disk usage falls below this value, even if some data older than the MINIMUM_RETENTION remains. Values range from 0 (0%) to 10000 (100%).

interval: Option<Duration>

Interval for running the pruner.

pages: Option<u64>

Number of SQLite pages to vacuum from the freelist during each pruner cycle. This value corresponds to N in the SQLite PRAGMA incremental_vacuum(N),

Trait Implementations

impl Args for PruningOptions

fn group_id() -> Option<Id>

Report the [ArgGroup::id][crate::ArgGroup::id] for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate Self via [FromArgMatches::from_arg_matches_mut]

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate self via [FromArgMatches::update_from_arg_matches_mut]

impl Clone for PruningOptions

fn clone(&self) -> PruningOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CommandFactory for PruningOptions

fn command<'b>() -> Command

Build a [Command] that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a [Command] that can update self.

impl Debug for PruningOptions

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

Formats the value using the given formatter.

impl From<PruningOptions> for PrunerCfg

fn from(opt: PruningOptions) -> Self

Converts to this type from the input type.

impl FromArgMatches for PruningOptions

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for PruningOptions

fn parse() -> Self

Parse from std::env::args_os(), [exit][Error::exit] on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, [exit][Error::exit] on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, [exit][Error::exit] on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.

impl Copy for PruningOptions