Struct TransactionDBCheckpoint 

pub struct TransactionDBCheckpoint<'db> { /* private fields */ }

TransactionDB checkpoint object.

Used to create physical checkpoints of a TransactionDB.

Implementations

impl<'db> TransactionDBCheckpoint<'db>

pub fn new<T: ThreadMode>(db: &'db TransactionDB<T>) -> Result<Self, Error>

Creates a new checkpoint object for the specified TransactionDB.

Does not actually produce checkpoints, call .create_checkpoint() or .create_checkpoint_with_log_size() to produce a DB checkpoint.

pub fn create_checkpoint<P: AsRef<Path>>(&self, path: P) -> Result<(), Error>

Creates a new physical RocksDB checkpoint in the directory specified by path.

See Checkpoint::create_checkpoint for details on checkpoint behavior and the default log_size_for_flush value.

pub fn create_checkpoint_with_log_size<P: AsRef<Path>>( &self, path: P, log_size_for_flush: u64, ) -> Result<(), Error>

Creates a new physical RocksDB checkpoint in path, allowing the caller to control log_size_for_flush.

See Checkpoint::create_checkpoint_with_log_size for the semantics of log_size_for_flush.

Trait Implementations

impl Drop for TransactionDBCheckpoint<'_>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.