Struct DBBuilder

pub struct DBBuilder { /* private fields */ }

Struct to construct database

Example

use nut::DBBuilder;

let db = DBBuilder::new("./test.db").read_only(true).build();

Implementations

impl DBBuilder

pub fn new<P: AsRef<Path>>(path: P) -> Self

Creates new Builder, path required.

pub fn path<P: AsRef<Path>>(self, path: P) -> Self

Path to db file

pub fn no_grow_sync(self, v: bool) -> Self

Sets the DB.no_grow_sync flag before memory mapping the file.

Default: false

pub fn read_only(self, v: bool) -> Self

Open database in read-only mode.

If database opened in read only mode file will be locked shared and exclusively otherwise.

Default: false

pub fn initial_mmap_size(self, v: usize) -> Self

Initial mmap size of the database

in bytes. Read transactions won’t block write transaction

if the initial_mmap_size is large enough to hold database mmap size. (See DB.begin for more information)

If = 0, the initial map size is size of first 4 pages.

If initial_mmap_size is smaller than the previous database size, it takes no effect.

Default: 0 (mmap will be equal to 4 page sizes)

pub fn autoremove(self, v: bool) -> Self

Defines whether db file will be removed after db close

Default: false

pub fn checkmode(self, v: CheckMode) -> Self

Defines database checking mode

Default: CheckMode::No

pub fn batch_delay(self, v: Duration) -> Self

Defines batch delay time

Default: 10 seconds

pub fn batch_size(self, v: usize) -> Self

Defines max batch size. If size equals 0, size is unlimited

Default: 1000

pub fn page_size(self, v: usize) -> Self

Defines page size to initialize db with. When opening existing db its page size will be used.

Default: page size defined by OS

pub fn build(self) -> Result<DB, Error>

Builds and returns DB instance