Struct kv::Config

pub struct Config {
    pub path: PathBuf,
    pub temporary: bool,
    pub use_compression: bool,
    pub flush_every_ms: Option<u64>,
    pub cache_capacity: Option<u64>,
    pub segment_size: Option<usize>,
}

Config is used to create a new store

Fields

path: PathBuf

The path field determines where the database will be created

temporary: bool

The temporary field specifies if the database will be destroyed on close

use_compression: bool

Enable compression by setting use_compression to true

flush_every_ms: Option<u64>

Specify the flush frequency

cache_capacity: Option<u64>

Specify the cache capacity in bytes

segment_size: Option<usize>

Specify the segment size for compatibility

Implementations

impl Config

pub fn new<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 use_compression(self, use_compression: bool) -> Config

Set compression field

pub fn temporary(self, temporary: bool) -> Config

Toggle temporary value

pub fn flush_every_ms(self, ms: u64) -> Config

Set flush frequency

pub fn cache_capacity(self, bytes: u64) -> Config

Set cache capacity

pub fn segment_size(self, kb: usize) -> Config

Set cache capacity

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<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: &Rhs) -> bool

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

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