Struct sc_cli::PruningParams

pub struct PruningParams {
    pub state_pruning: Option<DatabasePruningMode>,
    pub blocks_pruning: DatabasePruningMode,
}

Parameters to define the pruning mode

Fields

state_pruning: Option<DatabasePruningMode>

Specify the state pruning mode.

This mode specifies when the block’s state (ie, storage) should be pruned (ie, removed) from the database.

This setting can only be set on the first creation of the database. Every subsequent run will load the pruning mode from the database and will error if the stored mode doesn’t match this CLI value. It is fine to drop this CLI flag for subsequent runs.

Possible values:

• archive:

  Keep the state of all blocks.

• ‘archive-canonical’

  Keep only the state of finalized blocks.

• number

  Keep the state of the last number of finalized blocks.

[default: 256]

blocks_pruning: DatabasePruningMode

Specify the blocks pruning mode.

This mode specifies when the block’s body (including justifications) should be pruned (ie, removed) from the database.

Possible values:

• ‘archive’

  Keep all blocks.

• ‘archive-canonical’

  Keep only finalized blocks.

• number

Keep the last number of finalized blocks.

Implementations

impl PruningParams

pub fn state_pruning(&self) -> Result<Option<PruningMode>>

Get the pruning value from the parameters

pub fn blocks_pruning(&self) -> Result<BlocksPruning>

Get the block pruning value from the parameters

Trait Implementations

impl Args for PruningParams

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

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

Append to Command so it can instantiate Self.

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

Append to Command so it can update self.

impl Clone for PruningParams

fn clone(&self) -> PruningParams

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PruningParams

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

Formats the value using the given formatter.

impl FromArgMatches for PruningParams

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 PartialEq<PruningParams> for PruningParams

fn eq(&self, other: &PruningParams) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for PruningParams