Struct holochain_state::prelude::DbWrite
source · [−]pub struct DbWrite<Kind>(_)
where
Kind: DbKindT;
Expand description
The canonical representation of a (singleton) database. The wrapper contains methods for managing transactions and database connections,
Implementations
sourceimpl<Kind> DbWrite<Kind>where
Kind: 'static + DbKindT + Send + Sync,
impl<Kind> DbWrite<Kind>where
Kind: 'static + DbKindT + Send + Sync,
sourcepub fn open(
path_prefix: &Path,
kind: Kind
) -> Result<DbWrite<Kind>, DatabaseError>
pub fn open(
path_prefix: &Path,
kind: Kind
) -> Result<DbWrite<Kind>, DatabaseError>
Create or open an existing database reference,
pub async fn conn_write_permit(&self) -> impl Future<Output = PConnPermit>
pub fn open_with_sync_level(
path_prefix: &Path,
kind: Kind,
sync_level: DbSyncLevel
) -> Result<DbWrite<Kind>, DatabaseError>
sourcepub fn test(path: &Path, kind: Kind) -> Result<DbWrite<Kind>, DatabaseError>
pub fn test(path: &Path, kind: Kind) -> Result<DbWrite<Kind>, DatabaseError>
Create a unique db in a temp dir with no static management of the connection pool, useful for testing.
pub fn test_in_mem(kind: Kind) -> Result<DbWrite<Kind>, DatabaseError>
sourcepub async fn remove(self) -> impl Future<Output = Result<(), DatabaseError>>
👎Deprecated: is this used?
pub async fn remove(self) -> impl Future<Output = Result<(), DatabaseError>>
Remove the db and directory
pub async fn async_commit<E, R, F>(
&self,
f: F
) -> impl Future<Output = Result<R, E>>where
E: 'static + From<DatabaseError> + Send,
F: 'static + FnOnce(&mut Transaction<'_>) -> Result<R, E> + Send,
R: 'static + Send,
pub fn test_commit<R, F>(&self, f: F) -> Rwhere
F: FnOnce(&mut Transaction<'_>) -> R,
sourcepub async fn async_commit_in_place<E, R, F>(
&self,
f: F
) -> impl Future<Output = Result<R, E>>where
E: From<DatabaseError>,
F: FnOnce(&mut Transaction<'_>) -> Result<R, E>,
R: Send,
pub async fn async_commit_in_place<E, R, F>(
&self,
f: F
) -> impl Future<Output = 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<Kind>>
pub fn conn(&self) -> Result<PConn, DatabaseError>
pub async fn conn_permit(&self) -> impl Future<Output = PConnPermit>
pub async fn async_reader<E, R, F>(
&self,
f: F
) -> impl Future<Output = Result<R, E>>where
E: 'static + From<DatabaseError> + Send,
F: 'static + FnOnce(Transaction<'_>) -> Result<R, E> + Send,
R: 'static + Send,
Trait Implementations
sourceimpl<Kind> PermittedConn for DbWrite<Kind>where
Kind: DbKindT,
impl<Kind> PermittedConn for DbWrite<Kind>where
Kind: DbKindT,
fn with_permit(&self, permit: PConnPermit) -> Result<PConnGuard, DatabaseError>
sourceimpl<Kind> ReadAccess<Kind> for DbWrite<Kind>where
Kind: DbKindT,
impl<Kind> ReadAccess<Kind> for DbWrite<Kind>where
Kind: DbKindT,
sourcefn async_reader<'life0, 'async_trait, E, R, F>(
&'life0 self,
f: F
) -> Pin<Box<dyn Future<Output = Result<R, E>> + Send + 'async_trait, Global>>where
'life0: 'async_trait,
E: 'static + From<DatabaseError> + Send + 'async_trait,
F: 'static + FnOnce(Transaction<'_>) -> Result<R, E> + Send + 'async_trait,
R: 'static + Send + 'async_trait,
DbWrite<Kind>: 'async_trait,
fn async_reader<'life0, 'async_trait, E, R, F>(
&'life0 self,
f: F
) -> Pin<Box<dyn Future<Output = Result<R, E>> + Send + 'async_trait, Global>>where
'life0: 'async_trait,
E: 'static + From<DatabaseError> + Send + 'async_trait,
F: 'static + FnOnce(Transaction<'_>) -> Result<R, E> + Send + 'async_trait,
R: 'static + Send + 'async_trait,
DbWrite<Kind>: 'async_trait,
Run an async read transaction on a background thread.
sourcefn sync_reader<E, R, F>(&self, f: F) -> Result<R, E>where
E: From<DatabaseError>,
F: FnOnce(Transaction<'_>) -> Result<R, E>,
fn sync_reader<E, R, F>(&self, f: F) -> Result<R, E>where
E: From<DatabaseError>,
F: FnOnce(Transaction<'_>) -> Result<R, E>,
Run an sync read transaction on a the current thread.
Auto Trait Implementations
impl<Kind> !RefUnwindSafe for DbWrite<Kind>
impl<Kind> Send for DbWrite<Kind>
impl<Kind> Sync for DbWrite<Kind>
impl<Kind> Unpin for DbWrite<Kind>where
Kind: Unpin,
impl<Kind> !UnwindSafe for DbWrite<Kind>
Blanket Implementations
impl<T> Any for Twhere
T: Any + ?Sized,
impl<T> Any for Twhere
T: Any + ?Sized,
fn type_id_compat(&self) -> TypeId
fn type_id_compat(&self) -> TypeId
TODO: once 1.33.0 is the minimum supported compiler version, remove
Any::type_id_compat and use StdAny::type_id instead.
https://github.com/rust-lang/rust/issues/27745 Read more
impl<T> ArchivePointee for T
impl<T> ArchivePointee for T
type ArchivedMetadata = ()
type ArchivedMetadata = ()
The archived version of the pointer metadata for this type.
fn pointer_metadata(
&<T as ArchivePointee>::ArchivedMetadata
) -> <T as Pointee>::Metadata
fn pointer_metadata(
&<T as ArchivePointee>::ArchivedMetadata
) -> <T as Pointee>::Metadata
Converts some archived metadata to the pointer metadata for itself.
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<F, W, T, D> Deserialize<With<T, W>, D> for Fwhere
W: DeserializeWith<F, T, D>,
D: Fallible + ?Sized,
F: ?Sized,
impl<F, W, T, D> Deserialize<With<T, W>, D> for Fwhere
W: DeserializeWith<F, T, D>,
D: Fallible + ?Sized,
F: ?Sized,
fn deserialize(
&self,
deserializer: &mut D
) -> Result<With<T, W>, <D as Fallible>::Error>
fn deserialize(
&self,
deserializer: &mut D
) -> Result<With<T, W>, <D as Fallible>::Error>
Deserializes using the given deserializer
impl<T> FutureExt for T
impl<T> FutureExt for T
fn with_context(self, otel_cx: Context) -> WithContext<Self>
fn with_context(self, otel_cx: Context) -> WithContext<Self>
fn with_current_context(self) -> WithContext<Self>
fn with_current_context(self) -> WithContext<Self>
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
impl<T> Pointable for T
impl<T> Pointable for T
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self
from the equivalent element of its
superset. Read morefn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
Checks if
self
is actually part of its subset T
(and can be converted to it).fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
Use with care! Same as
self.to_subset
but without any property checks. Always succeeds.fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self
to the equivalent element of its superset.