Struct ConfigBuilder

pub struct ConfigBuilder { /* private fields */ }

Builder for Config.

Implementations

impl ConfigBuilder

pub fn new() -> Self

Create a new ConfigBuilder.

ConfigBuilder::build can be called immediately after this function to use default values.

pub fn build(self) -> Config

Build into a Config.

Default values

If ConfigBuilder::db_directory was not called, the default CUPRATE_TXPOOL_DIR will be used.

For all other values, Default::default is used.

pub const fn max_txpool_weight(self, max_txpool_weight: usize) -> Self

Sets a new maximum weight for the transaction pool.

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

Set a custom database directory (and file) Path.

pub fn sync_mode(self, sync_mode: SyncMode) -> Self

Calls cuprate_database::config::ConfigBuilder::sync_mode.

pub fn resize_algorithm(self, resize_algorithm: ResizeAlgorithm) -> Self

Calls cuprate_database::config::ConfigBuilder::resize_algorithm.

pub const fn reader_threads(self, reader_threads: ReaderThreads) -> Self

Set a custom ReaderThreads.

pub fn fast(self) -> Self

Tune the ConfigBuilder for the highest performing, but also most resource-intensive & maybe risky settings.

Good default for testing, and resource-available machines.

pub fn low_power(self) -> Self

Tune the ConfigBuilder for the lowest performing, but also least resource-intensive settings.

Good default for resource-limited machines, e.g. a cheap VPS.

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 Debug for ConfigBuilder

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

Formats the value using the given formatter.

impl Default for ConfigBuilder

fn default() -> Self

Returns the “default value” for a type.

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ConfigBuilder

fn eq(&self, other: &ConfigBuilder) -> 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 ConfigBuilder

fn partial_cmp(&self, other: &ConfigBuilder) -> 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 ConfigBuilder

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 ConfigBuilder

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