Struct TempDatabase 

pub struct TempDatabase<DB> { /* private fields */ }

Available on crate features test-utils only.

A database will delete the db dir when dropped.

Implementations

impl<DB> TempDatabase<DB>

pub fn new(db: DB, path: PathBuf) -> Self

Create new TempDatabase instance.

pub const fn db(&self) -> &DB

Returns the reference to inner db.

pub fn path(&self) -> &Path

Returns the path to the database.

pub fn into_inner_db(self) -> DB

Convert temp database into inner.

pub fn set_pre_transaction_hook(&self, hook: Box<dyn Fn() + Send + Sync>)

Sets TempDatabase new pre transaction creation hook.

pub fn set_post_transaction_hook(&self, hook: Box<dyn Fn() + Send + Sync>)

Sets TempDatabase new post transaction creation hook.

Trait Implementations

impl<DB: Database> Database for TempDatabase<DB>

type TX = <DB as Database>::TX

Read-Only database transaction

type TXMut = <DB as Database>::TXMut

Read-Write database transaction

fn tx(&self) -> Result<Self::TX, DatabaseError>

Create read only transaction.

fn tx_mut(&self) -> Result<Self::TXMut, DatabaseError>

Create read write transaction only possible if database is open with write access.

fn path(&self) -> PathBuf

Returns the path to the database directory.

fn oldest_reader_txnid(&self) -> Option<u64>

Returns the transaction ID of the oldest active reader, if available.

fn last_txnid(&self) -> Option<u64>

Returns the ID of the most recently committed transaction, if available.

fn view<T, F>(&self, f: F) -> Result<T, DatabaseError>

where F: FnOnce(&mut Self::TX) -> T,

Takes a function and passes a read-only transaction into it, making sure it’s closed in the end of the execution.

fn update<T, F>(&self, f: F) -> Result<T, DatabaseError>

where F: FnOnce(&Self::TXMut) -> T,

Takes a function and passes a write-read transaction into it, making sure it’s committed in the end of the execution.

impl<DB: DatabaseMetrics> DatabaseMetrics for TempDatabase<DB>

fn report_metrics(&self)

Reports metrics for the database.

fn gauge_metrics(&self) -> Vec<(&'static str, f64, Vec<Label>)>

Returns a list of Gauge metrics for the database.

fn counter_metrics(&self) -> Vec<(&'static str, u64, Vec<Label>)>

Returns a list of Counter metrics for the database.

fn histogram_metrics(&self) -> Vec<(&'static str, f64, Vec<Label>)>

Returns a list of Histogram metrics for the database.

impl<DB: Debug> Debug for TempDatabase<DB>

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

Formats the value using the given formatter.

impl<DB> Drop for TempDatabase<DB>

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 #130494)

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

Layout

Note: Unable to compute type layout, possibly due to this type having generic parameters. Layout can only be computed for concrete, fully-instantiated types.