Struct btm::BtmCfg

pub struct BtmCfg {
    pub enable: bool,
    pub itv: u64,
    pub cap: u64,
    pub mode: SnapMode,
    pub algo: SnapAlgo,
    pub target: 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

mode: SnapMode

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

algo: SnapAlgo

Fair or Fade, default to ‘Fair’

target: 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(&self) -> Result<SnapMode>

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

Trait Implementations

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.