Struct index::ConfigBuilder

pub struct ConfigBuilder { /* fields omitted */ }

Top-level configuration for the system.

Examples

let _config = pagecache::ConfigBuilder::default()
    .path("/path/to/data".to_owned())
    .cache_capacity(10_000_000_000)
    .use_compression(true)
    .flush_every_ms(Some(1000))
    .snapshot_after_ops(100_000);

Read-only mode let _config = pagecache::ConfigBuilder::default() .path("/path/to/data".to_owned()) .read_only(true);

Methods

impl ConfigBuilder

fn new() -> ConfigBuilder

Returns a default ConfigBuilder

fn path<P>(self, path: P) -> ConfigBuilder where
    P: AsRef<Path>, 

Set the path of the database (builder).

fn set_path<P>(&mut self, path: P) where
    P: AsRef<Path>, 

Set the path of the database

fn build(self) -> Config

Finalize the configuration.

fn set_io_bufs(&mut self, to: usize)

fn io_bufs(self, to: usize) -> ConfigBuilder

fn set_io_buf_size(&mut self, to: usize)

fn io_buf_size(self, to: usize) -> ConfigBuilder

fn set_min_items_per_segment(&mut self, to: usize)

fn min_items_per_segment(self, to: usize) -> ConfigBuilder

fn set_blink_fanout(&mut self, to: usize)

fn blink_fanout(self, to: usize) -> ConfigBuilder

fn set_page_consolidation_threshold(&mut self, to: usize)

fn page_consolidation_threshold(self, to: usize) -> ConfigBuilder

fn set_temporary(&mut self, to: bool)

fn temporary(self, to: bool) -> ConfigBuilder

fn set_read_only(&mut self, to: bool)

fn read_only(self, to: bool) -> ConfigBuilder

fn set_cache_bits(&mut self, to: usize)

fn cache_bits(self, to: usize) -> ConfigBuilder

fn set_cache_capacity(&mut self, to: usize)

fn cache_capacity(self, to: usize) -> ConfigBuilder

fn set_use_os_cache(&mut self, to: bool)

fn use_os_cache(self, to: bool) -> ConfigBuilder

fn set_use_compression(&mut self, to: bool)

fn use_compression(self, to: bool) -> ConfigBuilder

fn set_zstd_compression_factor(&mut self, to: i32)

fn zstd_compression_factor(self, to: i32) -> ConfigBuilder

fn set_flush_every_ms(&mut self, to: Option<u64>)

fn flush_every_ms(self, to: Option<u64>) -> ConfigBuilder

fn set_snapshot_after_ops(&mut self, to: usize)

fn snapshot_after_ops(self, to: usize) -> ConfigBuilder

fn set_cache_fixup_threshold(&mut self, to: usize)

fn cache_fixup_threshold(self, to: usize) -> ConfigBuilder

fn set_segment_cleanup_threshold(&mut self, to: f64)

fn segment_cleanup_threshold(self, to: f64) -> ConfigBuilder

fn set_min_free_segments(&mut self, to: usize)

fn min_free_segments(self, to: usize) -> ConfigBuilder

fn set_zero_copy_storage(&mut self, to: bool)

fn zero_copy_storage(self, to: bool) -> ConfigBuilder

fn set_segment_mode(&mut self, to: SegmentMode)

fn segment_mode(self, to: SegmentMode) -> ConfigBuilder

fn set_snapshot_path(&mut self, to: Option<OsString>)

fn snapshot_path(self, to: Option<OsString>) -> ConfigBuilder

Trait Implementations

impl Clone for ConfigBuilder

fn clone(&self) -> ConfigBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Serialize for ConfigBuilder

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

impl Send for ConfigBuilder

impl<'de> Deserialize<'de> for ConfigBuilder

fn deserialize<__D>(
    __deserializer: __D
) -> Result<ConfigBuilder, <__D as Deserializer<'de>>::Error> where
    __D: Deserializer<'de>, 

impl PartialEq<ConfigBuilder> for ConfigBuilder

fn eq(&self, __arg_0: &ConfigBuilder) -> bool

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

fn ne(&self, __arg_0: &ConfigBuilder) -> bool

This method tests for !=.

impl Debug for ConfigBuilder

fn fmt(&self, __arg_0: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for ConfigBuilder

fn default() -> ConfigBuilder

Returns the "default value" for a type.