Struct Config

pub struct Config {
    pub network: Network,
    pub fast_sync: bool,
    pub tracing: TracingConfig,
    pub tokio: TokioConfig,
    pub rayon: RayonConfig,
    pub p2p: P2PConfig,
    pub storage: StorageConfig,
    pub fs: FileSystemConfig,
}

The config for all of Cuprate.

Fields

network: Network

The network cuprated should run on.

Valid values | “Mainnet”, “Testnet”, “Stagenet”

fast_sync: bool

Enable/disable fast sync.

Fast sync skips verification of old blocks by comparing block hashes to a built-in hash file, disabling this will significantly increase sync time. New blocks are still fully validated.

Type | boolean Valid values | true, false

tracing: TracingConfig

Configuration for cuprated’s logging system, tracing.

Tracing is used for logging to stdout and files.

tokio: TokioConfig

Configuration for cuprated’s asynchronous runtime system, tokio.

Tokio is used for network operations and the major services inside cuprated.

rayon: RayonConfig

Configuration for cuprated’s thread-pool system, rayon.

Rayon is used for CPU intensive tasks.

p2p: P2PConfig

Configuration for cuprated’s P2P system.

storage: StorageConfig

Configuration for persistent data storage.

fs: FileSystemConfig

Configuration for the file-system.

Implementations

impl Config

pub fn write_docs(doc: &mut dyn TableLike)

impl Config

pub fn documented_config() -> String

Returns a default Config, with doc comments.

fn read_from_path(file: impl AsRef<Path>) -> Result<Self, Error>

Attempts to read a config file in toml format from the given Path.

Errors

Will return an Err if the file cannot be read or if the file is not a valid toml config.

pub const fn network(&self) -> Network

Returns the current Network we are running on.

pub fn clearnet_p2p_config(&self) -> P2PConfig<ClearNet>

The ClearNet, cuprate_p2p::P2PConfig.

pub const fn context_config(&self) -> ContextConfig

The ContextConfig.

pub fn blockchain_config(&self) -> Config

The cuprate_blockchain config.

pub fn txpool_config(&self) -> Config

The cuprate_txpool config.

pub fn block_downloader_config(&self) -> BlockDownloaderConfig

The BlockDownloaderConfig.

Trait Implementations

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.

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

where Config: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Config

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

Formats the value using the given formatter.

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