RedbDatabase

Struct RedbDatabase 

Source
pub struct RedbDatabase { /* private fields */ }
Expand description

Redb backend implementation.

Redb is a simple, portable, high-performance, ACID, embedded key-value database. A CrepeDB backend implementation using redb.

This struct wraps a redb Database and implements the CrepeDB Backend trait, allowing redb to be used as the storage engine for CrepeDB.

Implementations§

Source§

impl RedbDatabase

Source

pub fn open_or_create(path: impl AsRef<Path>) -> Result<RedbDatabase, Error>

Open or create a persistent redb database at the specified path.

If the database doesn’t exist, it will be created. If it exists, it will be opened.

§Arguments
  • path - The file path where the database should be stored
§Errors

Returns an error if the database cannot be created or opened.

§Example
let db = RedbDatabase::open_or_create("mydb.redb")?;
Source

pub fn memory() -> Result<RedbDatabase, Error>

Create an in-memory redb database.

The database exists only in memory and will be lost when dropped. This is useful for testing or temporary storage.

§Errors

Returns an error if the database cannot be created.

§Example
let db = RedbDatabase::memory()?;
Source

pub fn inner(&self) -> &Database

Get a reference to the underlying redb database.

Source

pub fn into_inner(self) -> Database

Consume the database and return the underlying redb database.

Trait Implementations§

Source§

impl Backend for RedbDatabase

Source§

type Error = Error

The error type returned by backend operations.
Source§

type ReadTxn<'a> = RedbReadTxn

The read transaction type.
Source§

type WriteTxn<'a> = RedbWriteTxn

The write transaction type.
Source§

fn read_txn( &self, ) -> Result<<RedbDatabase as Backend>::ReadTxn<'_>, <RedbDatabase as Backend>::Error>

Begin a read transaction. Read more
Source§

fn write_txn( &self, ) -> Result<<RedbDatabase as Backend>::WriteTxn<'_>, <RedbDatabase as Backend>::Error>

Begin a write transaction. Read more

Auto Trait Implementations§

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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, 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.