Struct Database

pub struct Database<K, V>where
    K: Ord + Clone + Debug + Sync + Send + 'static,
    V: Eq + Clone + Debug + Sync + Send + 'static,
{ /* private fields */ }

Expand description

A transactional in-memory database

Implementations§

impl<K, V> Database<K, V>
where K: Ord + Clone + Debug + Sync + Send + 'static, V: Eq + Clone + Debug + Sync + Send + 'static,

pub fn new() -> Self

Create a new transactional in-memory database

pub fn with_gc(self) -> Self

Configure the database to use inactive garbage collection.

This function will create a background thread which will periodically remove any MVCC transaction entries which are older than the current database timestamp, and which are no longer being used by any long-running transactions. Effectively previous versions are cleaned up and removed as soon as possible, whilst ensuring that transaction snapshots still operate correctly.

pub fn with_gc_history(self, history: Duration) -> Self

Configure the database to use historic garbage collection.

This function will create a background thread which will periodically remove any MVCC transaction entries which are older than the historic duration subtracted from the current database timestamp, and which are no longer being used by any long-running transactions. Effectively previous versions are cleaned up and removed if the transaction entries are older than the specified duration, whilst ensuring that transaction snapshots still operate correctly.

pub fn transaction(&self, write: bool) -> Transaction<K, V>

Start a new transaction on this database

Trait Implementations§

impl<K, V> Default for Database<K, V>
where K: Ord + Clone + Debug + Sync + Send + 'static, V: Eq + Clone + Debug + Sync + Send + 'static,

fn default() -> Self

Returns the “default value” for a type. Read more

impl<K, V> Deref for Database<K, V>
where K: Ord + Clone + Debug + Sync + Send + 'static, V: Eq + Clone + Debug + Sync + Send + 'static,

type Target = Inner<K, V>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<K, V> Drop for Database<K, V>
where K: Ord + Clone + Debug + Sync + Send + 'static, V: Eq + Clone + Debug + Sync + Send + 'static,

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

impl<K, V> Freeze for Database<K, V>

impl<K, V> !RefUnwindSafe for Database<K, V>

impl<K, V> Send for Database<K, V>

impl<K, V> Sync for Database<K, V>

impl<K, V> Unpin for Database<K, V>

impl<K, V> !UnwindSafe for Database<K, V>

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

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

Initializes a with the given initializer. Read more

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

Dereferences the given pointer. Read more

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

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

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

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)

The target type on which the method may be called.

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.