Struct btm::BtmCfg

pub struct BtmCfg {
    pub enable: bool,
    pub itv: u64,
    pub cap: u64,
    pub cap_clean_kept: usize,
    pub mode: SnapMode,
    pub algo: SnapAlgo,
    pub volume: String,
}

Config structure of snapshot

Fields

enable: bool

a global switch for enabling snapshot functions

itv: u64

interval between adjacent snapshots, default to 10 blocks

cap: u64

the maximum number of snapshots that will be stored, default to 100

cap_clean_kept: usize

how many snapshots should be kept after a clean_snapshots

mode: SnapMode

Zfs or Btrfs or External, will try a guess if missing

algo: SnapAlgo

Fair or Fade, default to ‘Fair’

volume: String

a data volume containing both ledger data and tendermint data

Implementations

impl BtmCfg

pub fn new() -> Self

create a simple instance

pub fn new_client_hdr() -> Self

Used in client side

pub fn snapshot(&self, idx: u64) -> Result<()>

generate a snapshot for the latest state of blockchain

pub fn rollback(&self, idx: Option<u64>, strict: bool) -> Result<()>

rollback the state of blockchain to a specificed height

pub fn get_sorted_snapshots(&self) -> Result<Vec<u64>>

Get snapshot list in ‘DESC’ order.

pub fn guess_mode(volume: &str) -> Result<SnapMode>

try to guess a correct mode NOTE: not suitable for External mode

pub fn list_snapshots(&self) -> Result<()>

List all existing snapshots.

pub fn clean_snapshots(&self) -> Result<()>

Clean all existing snapshots.

Trait Implementations

impl Args for BtmCfg

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

Append to Command so it can instantiate Self.

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

Append to Command so it can update self.

impl Clone for BtmCfg

fn clone(&self) -> BtmCfg

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CommandFactory for BtmCfg

fn into_app<'b>() -> Command<'b>

Deprecated, replaced with CommandFactory::command

fn into_app_for_update<'b>() -> Command<'b>

Deprecated, replaced with CommandFactory::command_for_update

fn command<'help>() -> App<'help>

Build a Command that can instantiate Self.

fn command_for_update<'help>() -> App<'help>

Build a Command that can update self.

impl Debug for BtmCfg

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

Formats the value using the given formatter.

impl Default for BtmCfg

fn default() -> Self

Returns the “default value” for a type.

impl FromArgMatches for BtmCfg

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 BtmCfg

fn parse() -> Self

Parse from std::env::args_os(), 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) -> Selfwhere
    I: IntoIterator<Item = T>,
    T: Into<OsString> + Clone,

Parse from iterator, 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 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.