Struct ConsensusPruningOptions

pub struct ConsensusPruningOptions {
    target_retention: u64,
    minimum_retention: u64,
    target_usage: u64,
}

Pruning parameters for ephemeral consensus storage.

Fields

target_retention: u64

Number of views to try to retain in consensus storage before data that hasn’t been archived is garbage collected.

The longer this is, the more certain that all data will eventually be archived, even if there are temporary problems with archive storage or partially missing data. This can be set very large, as most data is garbage collected as soon as it is finalized by consensus. This setting only applies to views which never get decided (ie forks in consensus) and views for which this node is partially offline. These should be exceptionally rare.

Note that in extreme scenarios, data may be garbage collected even before TARGET_RETENTION views, if consensus storage exceeds TARGET_USAGE. For a hard lower bound on how long consensus data will be retained, see MINIMUM_RETENTION.

The default of 302000 views equates to approximately 1 week (604800 seconds) at an average view time of 2s.

minimum_retention: u64

Minimum number of views to try to retain in consensus storage before data that hasn’t been archived is garbage collected.

This bound allows data to be retained even if consensus storage occupies more than TARGET_USAGE. This can be used to ensure sufficient time to move consensus data to archival storage as necessary, even under extreme circumstances where otherwise garbage collection would kick in based on TARGET_RETENTION.

The default of 130000 views equates to approximately 3 days (259200 seconds) at an average view time of 2s.

target_usage: u64

Amount (in bytes) of data to retain in consensus storage before garbage collecting more aggressively.

See also TARGET_RETENTION and MINIMUM_RETENTION.

Trait Implementations

impl Args for ConsensusPruningOptions

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 ConsensusPruningOptions

fn clone(&self) -> ConsensusPruningOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CommandFactory for ConsensusPruningOptions

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 ConsensusPruningOptions

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

Formats the value using the given formatter.

impl FromArgMatches for ConsensusPruningOptions

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 ConsensusPruningOptions

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 ConsensusPruningOptions