Struct kv::Config

pub struct Config {
    pub map_size: usize,
    pub max_readers: u32,
    pub path: PathBuf,
    pub readonly: bool,
    pub buckets: HashMap<String, Flag>,
    // some fields omitted
}

Config is used to create a new store

Fields

map_size: usize

The map_size field determines the maximum number of bytes stored in the database

max_readers: u32

The max_readers field determines the maximum number of readers for a given database

path: PathBuf

The path field determines where the database will be created

readonly: bool

Readonly sets the MDB_RDONLY flag when opening the database

buckets: HashMap<String, Flag>

Whitelisted buckets and DatabaseFlags

Methods

impl Config

pub fn default<P: AsRef<Path>>(p: P) -> Config

Create a default configuration object

pub fn save_to<W: Write>(&self, w: W) -> Result<(), Error>

Save Config to an io::Write

pub fn save<P: AsRef<Path>>(&self, path: P) -> Result<(), Error>

Save Config to a file

pub fn load_from<R: Read>(r: R) -> Result<Config, Error>

Load configuration from an io::Read

pub fn load<P: AsRef<Path>>(path: P) -> Result<Config, Error>

Load configuration to a file

pub fn set_map_size(&mut self, n: usize) -> &mut Config

Set map_size field

pub fn set_max_readers(&mut self, n: u32) -> &mut Config

Set max_readers field

pub fn flags(&self) -> EnvironmentFlags

Get flags field (DatabaseFlags)

pub fn flag(&mut self, f: EnvironmentFlags) -> &mut Config

Set flags field (DatabaseFlags)

pub fn set_path<P: AsRef<Path>>(&mut self, p: P) -> &mut Config

Set path field

pub fn bucket<S: AsRef<str>>(&mut self, name: S, f: Option<Flag>) -> &mut Config

Add a bucket

pub fn readonly(&mut self, readonly: bool) -> &mut Config

Set to readonly

Trait Implementations

impl PartialEq<Config> for Config

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

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 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<'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.