pub struct FdbTenant { /* private fields */ }
Expand description
FdbTenant
provides APIs for transactionally interacting with
Tenant
s.
The simplest correct programs using tentants will make use of the
run
and read
methods. run
will call commit
after
the user code has been executed.
A handle to FDB tentant. All reads and writes to the tenant are transactional.
A FdbTenant
can be created using open_tenant
method.
Implementations
sourceimpl FdbTenant
impl FdbTenant
sourcepub fn create_transaction(&self) -> FdbResult<FdbTransaction>
pub fn create_transaction(&self) -> FdbResult<FdbTransaction>
Creates a FdbTransaction
that operates on this
FdbTenant
.
sourcepub async fn run<T, F, Fut>(&self, f: F) -> FdbResult<T> where
F: FnMut(FdbTransaction) -> Fut,
Fut: Future<Output = FdbResult<T>>,
pub async fn run<T, F, Fut>(&self, f: F) -> FdbResult<T> where
F: FnMut(FdbTransaction) -> Fut,
Fut: Future<Output = FdbResult<T>>,
Runs a closure in the context that takes a FdbTransaction
.
Note
The closure FnMut: FnMut(FdbTransaction) -> Fut
will run
multiple times (retry) when certain errors are
encountered. Therefore the closure should be prepared to be
called more than once. This consideration means that the
closure should use caution when modifying state.
sourcepub async fn read<T, F, Fut>(&self, f: F) -> FdbResult<T> where
F: FnMut(FdbReadTransaction) -> Fut,
Fut: Future<Output = FdbResult<T>>,
pub async fn read<T, F, Fut>(&self, f: F) -> FdbResult<T> where
F: FnMut(FdbReadTransaction) -> Fut,
Fut: Future<Output = FdbResult<T>>,
Runs a closure in the context that takes a
FdbReadTransaction
.
Note
The closure F: FnMut(FdbReadTransaction) -> Fut
will run
multiple times (retry) when certain errors are
encountered. Therefore the closure should be prepared to be
called more than once. This consideration means that the
closure should use caution when modifying state.
Trait Implementations
impl Send for FdbTenant
impl Sync for FdbTenant
Auto Trait Implementations
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
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
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more