Skip to main content

CKBAppConfig

ckb_app_config

Struct CKBAppConfig 

Source 
pub struct CKBAppConfig {
Show 19 fields
    pub bin_name: String,
    pub root_dir: PathBuf,
    pub data_dir: PathBuf,
    pub ancient: PathBuf,
    pub tmp_dir: Option<PathBuf>,
    pub logger: LogConfig,
    pub metrics: MetricsConfig,
    pub memory_tracker: MemoryTrackerConfig,
    pub chain: ChainConfig,
    pub block_assembler: Option<BlockAssemblerConfig>,
    pub db: DBConfig,
    pub network: NetworkConfig,
    pub rpc: RpcConfig,
    pub tx_pool: TxPoolConfig,
    pub store: StoreConfig,
    pub alert_signature: Option<NetworkAlertConfig>,
    pub notify: NotifyConfig,
    pub indexer: IndexerConfig,
    pub fee_estimator: FeeEstimatorConfig,

}
Expand description

The main config file for the most subcommands. Usually it is the ckb.toml in the CKB root directory.

Attention: Changing the order of fields will break integration test, see module doc.

Fields§

§bin_name: String

The binary name.

§root_dir: PathBuf

The root directory.

§data_dir: PathBuf

The data directory.

§ancient: PathBuf

freezer files path

§tmp_dir: Option<PathBuf>

The directory to store temporary files.

§logger: LogConfig

Logger config options.

§metrics: MetricsConfig

Metrics options.

Developers can collect metrics for performance tuning and troubleshooting.

§memory_tracker: MemoryTrackerConfig

Memory tracker options.

Developers can enable memory tracker to analyze the process memory usage.

§chain: ChainConfig

Chain config options.

§block_assembler: Option<BlockAssemblerConfig>

Block assembler options.

§db: DBConfig

Database config options.

§network: NetworkConfig

Network config options.

§rpc: RpcConfig

RPC config options.

§tx_pool: TxPoolConfig

Tx pool config options.

§store: StoreConfig

Store config options.

§alert_signature: Option<NetworkAlertConfig>

P2P alert config options.

§notify: NotifyConfig

Notify config options.

§indexer: IndexerConfig

Indexer config options.

§fee_estimator: FeeEstimatorConfig

Fee estimator config options.

Implementations§

Source§

impl CKBAppConfig

Source

pub fn load_from_slice(slice: &[u8]) -> Result<Self, ExitCode>

Load a new instance from a file

Trait Implementations§

Source§

impl Clone for CKBAppConfig

Source§

fn clone(&self) -> CKBAppConfig

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CKBAppConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Serialize for CKBAppConfig

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> AsAny for T
where T: Any,

Source§

fn as_any(&self) -> &(dyn Any + 'static)

Cast to trait Any
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V