Struct matterdb::rocksdb::RocksDB[−][src]

pub struct RocksDB { /* fields omitted */ }

Database implementation on top of RocksDB backend.

RocksDB is an embedded database for key-value data, which is optimized for fast storage. This structure is required to potentially adapt the interface to use different databases.

Implementations

impl RocksDB[src]

pub fn open<P: AsRef<Path>>(path: P, options: &DBOptions) -> Result<Self>[src]

Opens a database stored at the specified path with the specified options.

If the database does not exist at the indicated path and the option create_if_missing is switched on in DBOptions, a new database will be created at the indicated path.

pub fn create_checkpoint<T: AsRef<Path>>(&self, path: T) -> Result<()>[src]

Creates checkpoint of this database in the given directory. See RocksDB docs for details.

Successfully created checkpoint can be opened using RocksDB::open.

pub fn get_db_lock_guard(&self) -> ShardedLockReadGuard<'_, DB>[src]

Retrieves read lock guard containing underlying rocksdb::DB.

Trait Implementations

impl Clone for RocksDB[src]

fn clone(&self) -> RocksDB[src]

Returns a copy of the value. Read more

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

impl Database for RocksDB[src]

fn snapshot(&self) -> Box<dyn Snapshot>[src]

Creates a new snapshot of the database from its current state.

fn merge(&self, patch: Patch) -> Result<()>[src]

Atomically applies a sequence of patch changes to the database. Read more

fn merge_sync(&self, patch: Patch) -> Result<()>[src]

Atomically applies a sequence of patch changes to the database with fsync. Read more

fn fork(&self) -> Fork[src]

Creates a new fork of the database from its current state.

impl Debug for RocksDB[src]

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

Formats the value using the given formatter. Read more

Auto Trait Implementations

impl RefUnwindSafe for RocksDB

impl Send for RocksDB

impl Sync for RocksDB

impl Unpin for RocksDB

impl UnwindSafe for RocksDB

Blanket Implementations

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

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T, U> Into<U> for T where
    U: From<T>, [src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<T> Pointable for T

pub const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

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

Initializes a with the given initializer. Read more

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

Dereferences the given pointer. Read more

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

Mutably dereferences the given pointer. Read more

pub unsafe fn drop(ptr: usize)

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

impl<T> ToOwned for T where
    T: Clone, [src]

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T[src]

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

pub fn clone_into(&self, target: &mut T)[src]

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

recently added

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

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

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

The type returned in the event of a conversion error.

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

Performs the conversion.