Struct Config

pub struct Config {
    pub sync_mode: SyncMode,
    pub reader_threads: NonZeroUsize,
    pub resize_algorithm: ResizeAlgorithm,
    /* private fields */
}

Database Env configuration.

This is the struct passed to Env::open that allows the database to be configured in various ways.

For construction, use ConfigBuilder.

Fields

sync_mode: SyncMode

Disk synchronization mode.

reader_threads: NonZeroUsize

Database reader thread count.

Set the number of slots in the reader table.

This is only used in LMDB, see here.

By default, this value is READER_THREADS_DEFAULT.

resize_algorithm: ResizeAlgorithm

Database memory map resizing algorithm.

This is used as the default fallback, but custom algorithms can be used as well with Env::resize_map.

Implementations

impl Config

pub fn new(db_directory: Cow<'static, Path>) -> Self

Create a new Config with sane default settings.

The Config::db_directory must be passed.

All other values will be Default::default.

use cuprate_database::{config::*, resize::*, DATABASE_DATA_FILENAME};

let tmp_dir = tempfile::tempdir().unwrap();
let db_directory = tmp_dir.path().to_owned();
let config = Config::new(db_directory.clone().into());

assert_eq!(*config.db_directory(), db_directory);
assert!(config.db_file().starts_with(db_directory));
assert!(config.db_file().ends_with(DATABASE_DATA_FILENAME));
assert_eq!(config.sync_mode, SyncMode::default());
assert_eq!(config.reader_threads, READER_THREADS_DEFAULT);
assert_eq!(config.resize_algorithm, ResizeAlgorithm::default());

pub const fn db_directory(&self) -> &Cow<'_, Path>

Return the absolute Path to the database directory.

pub const fn db_file(&self) -> &Cow<'_, Path>

Return the absolute Path to the database data file.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Config

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Config

fn eq(&self, other: &Config) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Config

fn partial_cmp(&self, other: &Config) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Config

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Config

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: 88 bytes