Struct gosh_database::CheckpointDb

pub struct CheckpointDb { /* private fields */ }

Implementations

impl CheckpointDb

pub fn new<P: AsRef<Path>>(d: P) -> Self

Construct Checkpoint from directory.

Arguments

• d: root directory for checkpoint files

pub fn slot(self, n: i32) -> Self

Construct with checkpoint slot n.

pub fn create(&self) -> Self

Create missing db_connection field if chk_file is not None. Mainly for cmdline uses.

impl CheckpointDb

pub fn restore<T: Checkpoint>(&self, data: &mut T) -> Result<bool>

Restore chain from checkpoint. Return true if restored successfuly, false otherwise.

pub fn restored<T: Checkpoint>(&self) -> Result<T>

👎 Deprecated:

Please use load_from_latest instead

Return checkpointed T

pub fn load_from_latest<T: Checkpoint>(&self) -> Result<T>

Load latest struct T from checkpoint

pub fn load_from_slot_n<T: Checkpoint>(&self, slot: i32) -> Result<T>

Load struct T from checkpoint in slot

pub fn commit<T: Checkpoint>(&self, data: &T) -> Result<bool>

Commit a checkpoint into database. Return true if committed, false otherwise.

Trait Implementations

impl Clone for CheckpointDb

fn clone(&self) -> CheckpointDb

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CheckpointDb

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

Formats the value using the given formatter.

impl Default for CheckpointDb

fn default() -> CheckpointDb

Returns the “default value” for a type.

impl StructOpt for CheckpointDb

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.