Struct DbOptions 

pub struct DbOptions { /* private fields */ }

Available on crate feature std only.

Options for opening a Db, built fluently and finished with open.

Use this when the default Db::open is not enough — currently, to choose a SyncPolicy. The set of options is intentionally small and will only grow additively.

Examples

use bison_db::{DbOptions, SyncPolicy};
let db = DbOptions::new().sync(SyncPolicy::Always).open(&path)?;
assert_eq!(db.sync_policy(), SyncPolicy::Always);

Implementations

impl DbOptions

pub fn new() -> Self

Creates options with the defaults (SyncPolicy::Manual).

Examples

use bison_db::{DbOptions, SyncPolicy};
assert_eq!(DbOptions::new().build_sync_policy(), SyncPolicy::Manual);

pub fn sync(self, policy: SyncPolicy) -> Self

Sets the SyncPolicy for the store.

Examples

use bison_db::{DbOptions, SyncPolicy};
let opts = DbOptions::new().sync(SyncPolicy::Always);
assert_eq!(opts.build_sync_policy(), SyncPolicy::Always);

pub fn build_sync_policy(&self) -> SyncPolicy

Returns the SyncPolicy these options currently carry.

Examples

use bison_db::{DbOptions, SyncPolicy};
assert_eq!(DbOptions::new().build_sync_policy(), SyncPolicy::Manual);

pub fn open<P: AsRef<Path>>(self, path: P) -> Result<Db>

Opens (or creates) the store at path with these options.

Equivalent to Db::open when the options are the defaults.

Errors

Same as Db::open.

Examples

use bison_db::{DbOptions, SyncPolicy};
let db = DbOptions::new().sync(SyncPolicy::Always).open(&path)?;

Trait Implementations

impl Clone for DbOptions

fn clone(&self) -> DbOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for DbOptions

impl Debug for DbOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for DbOptions

fn default() -> DbOptions

Returns the “default value” for a type.