Struct sc_cli::PruningParams

pub struct PruningParams {
    pub pruning: Option<String>,
    pub keep_blocks: Option<u32>,
}

Parameters to define the pruning mode

Fields

pruning: Option<String>

Specify the state pruning mode, a number of blocks to keep or ‘archive’.

Default is to keep all block states if the node is running as a validator (i.e. ‘archive’), otherwise state is only kept for the last 256 blocks.

keep_blocks: Option<u32>

Specify the number of finalized blocks to keep in the database.

Default is to keep all blocks.

Implementations

impl PruningParams

pub fn state_pruning(
    &self,
    unsafe_pruning: bool,
    role: &Role
) -> Result<PruningMode>

Get the pruning value from the parameters

pub fn keep_blocks(&self) -> Result<KeepBlocks>

Get the block pruning value from the parameters

Trait Implementations

impl Debug for PruningParams

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

Formats the value using the given formatter.

impl StructOpt for PruningParams

fn clap<'a, 'b>() -> App<'a, 'b>

Returns clap::App corresponding to the struct.

fn from_clap(matches: &ArgMatches<'_>) -> Self

Builds the struct from clap::ArgMatches. It’s guaranteed to succeed if matches originates from an App generated by StructOpt::clap called on the same type, otherwise it must panic.

fn from_args() -> Self

Builds the struct from the command line arguments (std::env::args_os). Calls clap::Error::exit on failure, printing the error message and aborting the program.

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

Builds the struct from the command line arguments (std::env::args_os). Unlike StructOpt::from_args, returns clap::Error on failure instead of aborting the program, so calling .exit is up to you.

fn from_iter<I>(iter: I) -> Self where
    I: IntoIterator,
    <I as IntoIterator>::Item: Into<OsString>,
    <I as IntoIterator>::Item: Clone, 

Gets the struct from any iterator such as a Vec of your making. Print the error message and quit the program in case of failure.

fn from_iter_safe<I>(iter: I) -> Result<Self, Error> where
    I: IntoIterator,
    <I as IntoIterator>::Item: Into<OsString>,
    <I as IntoIterator>::Item: Clone, 

Gets the struct from any iterator such as a Vec of your making.