Struct jammdb::DB

pub struct DB(_);

A database

A DB can created from an OpenOptions builder, or by calling open. From a DB, you can create a Transaction to access the data in the database. Opening a transaction requires a mutable borrow though, so you need to clone the database to have concurrent transactions (you're really just cloning an Arc so it's pretty cheap).

Implementations

impl DB

pub fn open<P: AsRef<Path>>(path: P) -> Result<DB, Error>

Opens a database using the default OpenOptions.

Same as calling OpenOptions::new().open(path). Please read the documentation for OpenOptions::open for details.

Examples

use jammdb::{DB};

let db = DB::open("my.db")?;

// do whatever you want with the DB

pub fn tx(&self, writable: bool) -> Result<Transaction<'_>, Error>

Creates a Transaction. This transaction is either read-only or writable depending on the writable parameter. Please read the docs on a Transaction for more details.

pub fn pagesize(&self) -> u64

Returns the database's pagesize.

Trait Implementations

impl Clone for DB

fn clone(&self) -> DB

Returns a copy of the value.

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

Performs copy-assignment from source.