Struct holochain_state::test_utils::TestDb

pub struct TestDb<Kind: DbKindT> { /* private fields */ }

A test database in a temp directory

Implementations

impl<Kind: DbKindT> TestDb<Kind>

pub fn to_db(&self) -> DbWrite<Kind>

Accessor

pub fn into_tempdir(self) -> TempDir

Accessor

pub fn dump(&self, out: &Path) -> Result<()>

Dump db to a location.

pub async fn dump_tmp(&self)

Dump db into /tmp/test_dbs.

pub fn dna_hash(&self) -> Option<Arc<DnaHash>>

Methods from Deref<Target = DbWrite<Kind>>

pub async fn write_async<E, R, F>( &self, f: F ) -> impl Future<Output = Result<R, E>>where E: From<DatabaseError> + Send + 'static, F: FnOnce(&mut Transaction<'_>) -> Result<R, E> + Send + 'static, R: Send + 'static,

pub fn available_writer_count(&self) -> usize

pub fn available_reader_count(&self) -> usize

pub fn test_write<R, F>(&self, f: F) -> Rwhere F: FnOnce(&mut Transaction<'_>) -> R + Send + 'static, R: Send + 'static,

Methods from Deref<Target = DbRead<Kind>>

pub fn kind(&self) -> &Kind

Accessor for the DbKindT of the DbWrite

pub fn path(&self) -> &PathBuf

The environment’s path

pub async fn read_async<E, R, F>( &self, f: F ) -> impl Future<Output = Result<R, E>>where E: From<DatabaseError> + Send + 'static, F: FnOnce(Transaction<'_>) -> Result<R, E> + Send + 'static, R: Send + 'static,

Execute a read closure on the database by acquiring a connection from the pool, starting a new transaction and running the closure with that transaction.

Note that it is not enforced that your closure runs read-only operations or that it finishes quickly so it is up to the caller to use this function as intended.

pub async fn get_read_txn( &self ) -> impl Future<Output = Result<PTxnGuard, DatabaseError>>

Intended to be used for transactions that need to be kept open for a longer period of time than just running a sequence of reads using read_async. You should default to read_async and only call this if you have a good reason.

A valid reason for this is holding read transactions across multiple databases as part of a cascade query.

pub fn test_read<R, F>(&self, f: F) -> Rwhere F: FnOnce(Transaction<'_>) -> R + Send + 'static, R: Send + 'static,

Trait Implementations

impl<Kind: DbKindT> AsRef<DbWrite<Kind>> for TestDb<Kind>

fn as_ref(&self) -> &DbWrite<Kind>

Converts this type into a shared reference of the (usually inferred) input type.

impl<Kind: DbKindT> Borrow<DbWrite<Kind>> for TestDb<Kind>

fn borrow(&self) -> &DbWrite<Kind>

Immutably borrows from an owned value.

impl<Kind: DbKindT> Deref for TestDb<Kind>

type Target = DbWrite<Kind>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.