Struct sanakirja::Env

pub struct Env { /* private fields */ }

Environment, required to start any transactions. Thread-safe, but opening the same database several times in the same process is not cross-platform.

Implementations

impl Env

pub fn file_size<P: AsRef<Path>>(path: P) -> Result<u64, Error>

File size of the database path, if it exists.

pub fn size(&self) -> u64

Length of the environment.

pub fn set_flush_limit(&mut self, flush: u64)

Set the maximum number of dirty pages before triggering a flush.

pub fn flush_limit(&self) -> u64

Get the maximum number of dirty pages before triggering a flush.

pub fn new<P: AsRef<Path>>(path: P, length: u64) -> Result<Env, Error>

Initialize an environment. length must be a strictly positive multiple of 4096. The same file can only be open in one process or thread at the same time, and this is enforced by a locked file.

pub unsafe fn new_nolock<P: AsRef<Path>>(
    path: P,
    length: u64
) -> Result<Env, Error>

Same as new, but does not take a lock on the file system.

This method is provided because waiting for a lock on the file system may block the whole process, whereas.

However, the database is very likely to get corrupted if open more than once at the same time, even within the same process.

Therefore, do not use this method without another locking mechanism in place to avoid that situation.

pub fn txn_begin<'env>(&'env self) -> Result<Txn<'env>, Error>

Start a read-only transaction.

pub fn mut_txn_begin<'env>(&'env self) -> Result<MutTxn<'env, ()>, Error>

Start a mutable transaction. Mutable transactions that go out of scope are automatically aborted.

pub unsafe fn close(&mut self)

Close this repository. It is undefined behaviour to use it afterwards.

Trait Implementations

impl Drop for Env

fn drop(&mut self)

Executes the destructor for this type.

impl Send for Env

impl Sync for Env