Struct SerializableDb

Source
pub struct SerializableDb<K, V, S: AsyncSpawner> { /* private fields */ }
Expand description

A concurrent MVCC in-memory key-value database.

SerializableDb requires key to be Ord and CheapClone. The CheapClone bound here hints the user that the key should be cheap to clone, because it will be cloned at least one time during the write transaction.

Comparing to OptimisticDb:

  1. SerializableDb support full serializable snapshot isolation, which can detect both direct dependencies and indirect dependencies.
  2. SerializableDb does not require key to implement Hash.
  3. But, OptimisticDb has more flexible write transaction APIs.

Implementations§

Source§

impl<K, V, S: AsyncSpawner> SerializableDb<K, V, S>

Source

pub async fn new() -> Self

Creates a new SerializableDb.

Source§

impl<K, V, S: AsyncSpawner> SerializableDb<K, V, S>

Source

pub async fn version(&self) -> u64

Returns the current read version of the database.

Source

pub async fn read( &self, ) -> ReadTransaction<K, V, SerializableDb<K, V, S>, BTreeCm<K>, S>

Create a read transaction.

Source§

impl<K, V, S> SerializableDb<K, V, S>
where K: CheapClone + Ord, S: AsyncSpawner,

Source

pub async fn optimistic_write(&self) -> OptimisticTransaction<K, V, S>

Create a optimistic write transaction.

Optimistic write transaction is not a totally Serializable Snapshot Isolation transaction. It can handle most of write skew anomaly, but not all. Basically, all directly dependencies can be handled, but indirect dependencies (logical dependencies) can not be handled. If you need a totally Serializable Snapshot Isolation transaction, you should use SerializableDb::serializable_write instead.

Source

pub async fn serializable_write(&self) -> SerializableTransaction<K, V, S>

Create a serializable write transaction.

Serializable write transaction is a totally Serializable Snapshot Isolation transaction. It can handle all kinds of write skew anomaly, including indirect dependencies (logical dependencies). If in your code, you do not care about indirect dependencies (logical dependencies), you can use SerializableDb::optimistic_write instead.

Source§

impl<K, V, S> SerializableDb<K, V, S>
where K: CheapClone + Ord + Send + 'static, V: Send + 'static, S: AsyncSpawner,

Source

pub fn compact(&self)

Compact the database.

Trait Implementations§

Source§

impl<K, V, S: AsyncSpawner> Clone for SerializableDb<K, V, S>

Source§

fn clone(&self) -> Self

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

§

impl<K, V, S> Freeze for SerializableDb<K, V, S>

§

impl<K, V, S> !RefUnwindSafe for SerializableDb<K, V, S>

§

impl<K, V, S> Send for SerializableDb<K, V, S>
where K: Sync + Send, V: Sync + Send,

§

impl<K, V, S> Sync for SerializableDb<K, V, S>
where K: Sync + Send, V: Sync + Send,

§

impl<K, V, S> Unpin for SerializableDb<K, V, S>

§

impl<K, V, S> !UnwindSafe for SerializableDb<K, V, S>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more