Struct holochain_state::prelude::DbWrite

pub struct DbWrite(_);

The canonical representation of a (singleton) database. The wrapper contains methods for managing transactions and database connections,

Implementations

impl DbWrite

pub fn open(path_prefix: &Path, kind: DbKind) -> Result<DbWrite, DatabaseError>

Create or open an existing database reference,

pub fn open_with_sync_level(
    path_prefix: &Path,
    kind: DbKind,
    sync_level: DbSyncLevel
) -> Result<DbWrite, DatabaseError>

pub fn test(tmpdir: &TempDir, kind: DbKind) -> Result<DbWrite, DatabaseError>

Create a unique db in a temp dir with no static management of the connection pool, useful for testing.

pub async fn remove(self) -> Result<(), DatabaseError>

👎 Deprecated:

is this used?

Remove the db and directory

impl DbWrite

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

pub async fn async_commit_in_place<E, R, F>(&'_ self, f: F) -> Result<R, E> where
    E: From<DatabaseError>,
    F: FnOnce(&mut Transaction<'_>) -> Result<R, E>,
    R: Send, 

If possible prefer async_commit as this is slower and can starve chained futures.

Methods from Deref<Target = DbRead>

pub fn conn(&self) -> Result<PConn, DatabaseError>

pub fn inner(&self) -> DbRead

👎 Deprecated:

remove this identity function

pub fn kind(&self) -> &DbKind

Accessor for the DbKind of the DbWrite

pub fn path(&self) -> &PathBuf

The environment’s path

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

Trait Implementations

impl AsRef<DbRead> for DbWrite

pub fn as_ref(&self) -> &DbRead

Performs the conversion.

impl AsRef<DbWrite> for TestDb

pub fn as_ref(&self) -> &DbWrite

Performs the conversion.

impl Borrow<DbRead> for DbWrite

pub fn borrow(&self) -> &DbRead

Immutably borrows from an owned value.

impl Borrow<DbWrite> for TestDb

pub fn borrow(&self) -> &DbWrite

Immutably borrows from an owned value.

impl Clone for DbWrite

pub fn clone(&self) -> DbWrite

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Deref for DbWrite

type Target = DbRead

The resulting type after dereferencing.

pub fn deref(&self) -> &<DbWrite as Deref>::Target

Dereferences the value.

impl From<DbRead> for DbWrite

pub fn from(original: DbRead) -> DbWrite

Performs the conversion.

impl From<DbWrite> for DbRead

pub fn from(original: DbWrite) -> DbRead

Performs the conversion.

impl From<EnvWrite> for DbWrite

pub fn from(env: EnvWrite) -> DbWrite

Performs the conversion.