Struct thetadb::ThetaDB

pub struct ThetaDB { /* private fields */ }

The main database struct, all entry points are here.

Implementations

impl ThetaDB

pub fn open(path: impl AsRef<Path>) -> Result<Self>

Open a ThetaDB instance at the given file path with default options.

pub fn open_with_options( path: impl AsRef<Path>, options: Options ) -> Result<Self>

Open a ThetaDB instance at the given file path with the provided options.

pub fn options(&self) -> Options

Options used to configure the ThetaDB.

pub fn contains(&self, key: impl AsRef<[u8]>) -> Result<bool>

Check if the ThetaDB contains a given key.

pub fn get(&self, key: impl AsRef<[u8]>) -> Result<Option<Vec<u8>>>

Get the value associated with a given key.

pub fn put(&self, key: impl AsRef<[u8]>, value: impl AsRef<[u8]>) -> Result<()>

Insert or update a key-value pair into the ThetaDB.

pub fn delete(&self, key: impl AsRef<[u8]>) -> Result<()>

Delete a key-value pair from the ThetaDB.

pub fn view<T>(&self, f: impl FnOnce(&Tx<'_>) -> Result<T>) -> Result<T>

Perform a read-only transaction using closure on the ThetaDB.

pub fn update<T>( &self, f: impl FnOnce(&mut TxMut<'_>) -> Result<T> ) -> Result<T>

Perform a read-write transaction using closure on the ThetaDB.

pub fn begin_tx(&self) -> Result<Tx<'_>>

Start a read-only transaction.

pub fn begin_tx_mut(&self) -> Result<TxMut<'_>>

Start a read-write transaction.

pub fn first_cursor(&self) -> Result<CursorTx<'_>>

Get the cursor pointing to the first record in the ThetaDB.

pub fn last_cursor(&self) -> Result<CursorTx<'_>>

Get the cursor pointing to the last record in the ThetaDB.

pub fn cursor_from_key(&self, key: &[u8]) -> Result<CursorTx<'_>>

Get the cursor pointing to the specific record in the ThetaDB with the given key.

impl ThetaDB

pub fn debugger(&self) -> Result<Debugger<'_>>

Get a debugger for the ThetaDB.