Struct fdb::tenant::FdbTenant

pub struct FdbTenant { /* private fields */ }

FdbTenant provides APIs for transactionally interacting with Tenants.

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

impl FdbTenant

pub fn create_transaction(&self) -> FdbResult<FdbTransaction>

Creates a FdbTransaction that operates on this FdbTenant.

pub fn get_name(&self) -> Tenant

Returns the name of this Tenant.

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.

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 Clone for FdbTenant

fn clone(&self) -> FdbTenant

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FdbTenant

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

Formats the value using the given formatter.

impl Drop for FdbTenant

fn drop(&mut self)

Executes the destructor for this type.

impl Send for FdbTenant

impl Sync for FdbTenant