Struct DatabaseHandle 

pub struct DatabaseHandle { /* private fields */ }

A handle to the database, returned by fwd_open_db.

These handles are passed to the other FFI functions.

Implementations

impl DatabaseHandle

pub fn new(args: DatabaseHandleArgs<'_>) -> Result<Self, Error>

Creates a new database handle from the given arguments.

Errors

If the path is empty, or if the configuration is invalid, this will return an error.

pub fn current_root_hash(&self) -> Option<HashKey>

Returns the current root hash of the database.

Errors

Never errors.

pub fn get_latest(&self, key: impl KeyType) -> Result<Option<Box<[u8]>>, Error>

Returns a value from the database for the given key from the latest root hash.

Errors

An error is returned if there was an i/o error while reading the value.

pub fn create_batch<'a>( &self, values: impl AsRef<[BatchOp<'a>]> + 'a, ) -> Result<Option<HashKey>, Error>

Creates and commits a proposal with the given values.

Errors

An error is returned if the proposal could not be created.

pub fn get_revision( &self, root: HashKey, ) -> Result<GetRevisionResult<'_>, Error>

Returns an owned handle to the revision corresponding to the provided root hash.

Errors

Returns an error if could not get the view from underlying database for the specified root hash, for example when the revision does not exist or an I/O error occurs while accessing the database.

pub fn reconstruct_from_view<'db>( &'db self, parent: &NodeStore<Committed, FileBacked>, batch: impl IntoBatchIter, ) -> Result<ReconstructedView<'db>, Error>

Reconstructs a view on top of an existing historical node store.

Errors

Returns an error if reconstruction fails.

pub fn apply_change_proof_to_parent( &self, start_hash: HashKey, change_proof: &FrozenChangeProof, ) -> Result<CreateProposalResult<'_>, Error>

Applies the BatchOps of a change proof to the parent.

Errors

Returns a LatestIsEmpty error if the trie is empty. A range proof should be used in this case.

pub fn dump_to_string(&self) -> Result<String, Error>

Dumps the Trie structure of the latest revision to a DOT (Graphviz) format string.

Errors

An error is returned if there was an i/o error while dumping the trie.

pub fn close(self) -> Result<(), Error>

Closes the database gracefully.

Errors

An error is returned if the persistence background thread panicked or errored during execution.

Trait Implementations

impl<'db> CView<'db> for &'db DatabaseHandle

fn handle(&self) -> &'db DatabaseHandle

Returns a reference to the database handle that is ultimately used to create the proposal. For the database handle, this returns itself. For, a proposal handle, this returns the handle that was used to create the proposal.

fn create_proposal( self, values: impl IntoBatchIter, ) -> Result<Proposal<'db>, Error>

Create a firewood::db::Proposal with the provided key-value pairs.

fn create_proposal_handle( self, values: impl IntoBatchIter, ) -> Result<CreateProposalResult<'db>, Error>

where Self: Sized,

Create a ProposalHandle from the values and return it with timing information.

impl Debug for DatabaseHandle

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

Formats the value using the given formatter.