Struct DB 

pub struct DB(/* private fields */);

Database

Implementations

impl<'a> DB

pub fn get_meta(file: &mut File) -> Result<Meta, String>

Returns meta info for given path

pub fn page_size(&self) -> usize

Returns database’s defined page size

pub fn remove(self) -> Result<(), Error>

Closes database and removes it’s data file

pub fn path(&self) -> &Path

pub fn read_only(&self) -> bool

pub fn opened(&self) -> bool

pub fn begin_tx(&'a self) -> Result<TxGuard<'a>, Error>

Starts a new transaction. Multiple read-only transactions can be used concurrently but only one write transaction can be used at a time.

Transactions should not be dependent on one another.

If a long running read transaction (for example, a snapshot transaction) is needed, you might want to set DBBuilder.initial_mmap_size to a large enough value to avoid potential blocking of write transaction.

pub fn begin_rw_tx(&'a mut self) -> Result<RWTxGuard<'a>, Error>

Starts a new writable transaction. Multiple read-only transactions can be used concurrently but only one write transaction can be used at a time.

Transactions should not be dependent on one another.

If a long running read transaction (for example, a snapshot transaction) is needed, you might want to set DBBuilder.initial_mmap_size to a large enough value to avoid potential blocking of write transaction.

pub fn update<'b>( &mut self, handler: Box<dyn FnMut(&mut Tx) -> Result<(), String> + 'b>, ) -> Result<(), Error>

shorthand for db.begin_rw_tx with additional guarantee for panic safery

pub fn view<'b>( &self, handler: Box<dyn Fn(&Tx) -> Result<(), String> + 'b>, ) -> Result<(), Error>

shorthand for db.begin_tx with additional guarantee for panic safery

pub fn batch( &mut self, handler: Box<dyn Fn(&mut Tx) -> Result<(), String> + Send>, ) -> Result<(), Error>

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

1. concurrent batch calls can be combined into a single transaction.

2. the function passed to batch may be called multiple times, regardless of whether it returns error or not.

This means that Batch function side effects must be idempotent and take permanent effect only after a successful return is seen in caller.

The maximum batch size and delay can be adjusted with DBBuilder.batch_size and DBBuilder.batch_delay, respectively.

Batch is only useful when there are multiple threads calling it. While calling it multiple times from single thread just blocks thread for each single batch call

pub fn stats(&self) -> Stats

pub fn info(&self) -> Info

pub fn meta(&self) -> Result<Meta, Error>

Trait Implementations

impl Clone for DB

fn clone(&self) -> DB

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Drop for DB

fn drop(&mut self)

Executes the destructor for this type.