Struct Environment

pub struct Environment { /* private fields */ }

Represents LMDB Environment. Should be opened using EnvBuilder

Implementations

impl Environment

pub fn new() -> EnvBuilder

pub fn reader_check(&self) -> MdbResult<c_int>

Check for stale entries in the reader lock table.

Returns the number of stale slots that were cleared.

pub fn stat(&self) -> MdbResult<MDB_stat>

Retrieve environment statistics

pub fn info(&self) -> MdbResult<MDB_envinfo>

pub fn sync(&self, force: bool) -> MdbResult<()>

Sync environment to disk

pub fn set_mapsize(&self, map_size: usize) -> MdbResult<()>

Sets map size. This can be called after open if no transactions are active in this process.

pub fn set_flags(&mut self, flags: EnvFlags, turn_on: bool) -> MdbResult<()>

This one sets only flags which are available for change even after opening, see also get_flags and get_all_flags

pub fn get_flags(&self) -> MdbResult<EnvFlags>

Get flags of environment, which could be changed after it was opened use get_all_flags if you need also creation time flags

pub fn get_all_flags(&self) -> MdbResult<EnvCreateFlags>

Get all flags of environment, including which were specified on creation See also get_flags if you’re interested only in modifiable flags

pub fn get_maxreaders(&self) -> MdbResult<c_uint>

pub fn get_maxkeysize(&self) -> c_int

pub fn copy_to_fd(&self, fd: mdb_filehandle_t) -> MdbResult<()>

Creates a backup copy in specified file descriptor

pub fn get_fd(&self) -> MdbResult<mdb_filehandle_t>

Gets file descriptor of this environment

pub fn copy_to_path<P: AsRef<Path>>(&self, path: P) -> MdbResult<()>

Creates a backup copy in specified path

pub fn new_transaction(&self) -> MdbResult<Transaction<'_>>

Creates a new read-write transaction

Use get_reader to get much faster lock-free alternative

pub fn get_reader(&self) -> MdbResult<ReadonlyTransaction<'_>>

Creates a readonly transaction

pub fn get_db(&self, db_name: &str, flags: DbFlags) -> MdbResult<DbHandle>

Opens existing DB

pub fn create_db(&self, db_name: &str, flags: DbFlags) -> MdbResult<DbHandle>

Opens or creates a DB

pub fn get_default_db(&self, flags: DbFlags) -> MdbResult<DbHandle>

Opens default DB with specified flags

Trait Implementations

impl Clone for Environment

fn clone(&self) -> Environment

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Environment

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

Formats the value using the given formatter.

impl Send for Environment

impl Sync for Environment