Struct EnvironmentBuilder

pub struct EnvironmentBuilder { /* private fields */ }

Available on crate feature mdbx only.

Options for opening or creating an environment.

Implementations

impl EnvironmentBuilder

pub fn open(&self, path: &Path) -> Result<Environment, Error>

Open an environment.

Database files will be opened with 644 permissions.

pub fn open_with_permissions( &self, path: &Path, mode: u32, ) -> Result<Environment, Error>

Open an environment with the provided UNIX permissions.

The path may not contain the null character.

pub fn set_kind(&mut self, kind: EnvironmentKind) -> &mut EnvironmentBuilder

Configures how this environment will be opened.

pub fn write_map(&mut self) -> &mut EnvironmentBuilder

Opens the environment with mdbx WRITEMAP

See also EnvironmentKind

pub fn set_flags(&mut self, flags: EnvironmentFlags) -> &mut EnvironmentBuilder

Sets the provided options in the environment.

pub fn set_max_readers(&mut self, max_readers: u64) -> &mut EnvironmentBuilder

Sets the maximum number of threads or reader slots for the environment.

This defines the number of slots in the lock table that is used to track readers in the the environment. The default is 126. Starting a read-only transaction normally ties a lock table slot to the Transaction object until it or the Environment object is destroyed.

pub fn set_max_dbs(&mut self, v: usize) -> &mut EnvironmentBuilder

Sets the maximum number of named databases for the environment.

This function is only needed if multiple databases will be used in the environment. Simpler applications that use the environment as a single unnamed database can ignore this option.

Currently a moderate number of slots are cheap but a huge number gets expensive: 7-120 words per transaction, and every Transaction::open_db() does a linear search of the opened slots.

pub fn set_sync_bytes(&mut self, v: usize) -> &mut EnvironmentBuilder

Sets the interprocess/shared threshold to force flush the data buffers to disk, if SyncMode::SafeNoSync is used.

pub fn set_sync_period(&mut self, v: Duration) -> &mut EnvironmentBuilder

Sets the interprocess/shared relative period since the last unsteady commit to force flush the data buffers to disk, if SyncMode::SafeNoSync is used.

pub fn set_rp_augment_limit(&mut self, v: u64) -> &mut EnvironmentBuilder

pub fn set_loose_limit(&mut self, v: u64) -> &mut EnvironmentBuilder

pub fn set_dp_reserve_limit(&mut self, v: u64) -> &mut EnvironmentBuilder

pub fn set_txn_dp_limit(&mut self, v: u64) -> &mut EnvironmentBuilder

pub fn set_spill_max_denominator(&mut self, v: u8) -> &mut EnvironmentBuilder

pub fn set_spill_min_denominator(&mut self, v: u8) -> &mut EnvironmentBuilder

pub fn set_geometry<R>( &mut self, geometry: Geometry<R>, ) -> &mut EnvironmentBuilder

where R: RangeBounds<usize>,

Set all size-related parameters of environment, including page size and the min/max size of the memory map.

pub fn set_log_level(&mut self, log_level: i32) -> &mut EnvironmentBuilder

pub fn set_handle_slow_readers( &mut self, hsr: extern "C" fn(_: *const MDBX_env, _: *const MDBX_txn, _: i32, _: u64, _: u64, _: u32, _: usize, _: i32) -> HandleSlowReadersReturnCode, ) -> &mut EnvironmentBuilder

Set the Handle-Slow-Readers callback. See HandleSlowReadersCallback for more information.

impl EnvironmentBuilder

pub fn set_max_read_transaction_duration( &mut self, max_read_transaction_duration: MaxReadTransactionDuration, ) -> &mut EnvironmentBuilder

Set the maximum time a read-only transaction can be open.

Trait Implementations

impl Clone for EnvironmentBuilder

fn clone(&self) -> EnvironmentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EnvironmentBuilder

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

Formats the value using the given formatter.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 288 bytes