Struct Bolt

pub struct Bolt { /* private fields */ }

The Bolt Database

Implementations

impl Bolt

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

Open creates and opens a database at the given path. If the file does not exist then it will be created automatically.

pub fn open_ro<T: AsRef<Path>>(path: T) -> Result<impl DbApi>

Opens a database as read-only at the given path. If the file does not exist then it will be created automatically.

pub fn open_mem() -> Result<Self>

Opens an in-memory database

Trait Implementations

impl Clone for Bolt

fn clone(&self) -> Bolt

Returns a copy of the value.

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

Performs copy-assignment from source.

impl DbApi for Bolt

fn begin(&self) -> Result<impl TxApi<'_>>

Begin starts a new transaction.

fn view<'tx, F: FnMut(TxRef<'tx>) -> Result<()>>(&'tx self, f: F) -> Result<()>

View executes a function within the context of a managed read-only transaction. Any error that is returned from the function is returned from the View() method.

fn stats(&self) -> Arc<DbStats>

Stats retrieves ongoing performance stats for the database.

fn path(&self) -> &DbPath

Returns the database’s path

fn info(&self) -> DbInfo

Returns the database internal information

fn close(self)

Close releases all database resources.

impl DbRwAPI for Bolt

fn begin_rw(&mut self) -> Result<impl TxRwApi<'_>>

Starts a new transaction. Multiple read-only transactions can be used concurrently but only one write transaction can be used at a time. Starting multiple write transactions will cause the calls to block and be serialized until the current write transaction finishes.

fn update<'tx, F: FnMut(TxRwRef<'tx>) -> Result<()>>( &'tx mut self, f: F, ) -> Result<()>

Executes a function within the context of a read-write managed transaction.

fn batch<F>(&mut self, f: F) -> Result<()>

where F: FnMut(&mut TxRwRef<'_>) -> Result<()> + Send + Sync + Clone + 'static,

Calls a function as part of a batch. It behaves similar to Update, except:

fn sync(&mut self) -> Result<()>

Executes fdatasync() against the database file handle.