Struct sc_cli::SharedParams

pub struct SharedParams {
    pub chain: Option<String>,
    pub dev: bool,
    pub base_path: Option<PathBuf>,
    pub log: Vec<String>,
    pub detailed_log_output: bool,
    pub disable_log_color: bool,
    pub enable_log_reloading: bool,
    pub tracing_targets: Option<String>,
    pub tracing_receiver: TracingReceiver,
}

Shared parameters used by all CoreParams.

Fields

chain: Option<String>

Specify the chain specification.

It can be one of the predefined ones (dev, local, or staging) or it can be a path to a file with the chainspec (such as one exported by the build-spec subcommand).

dev: bool

Specify the development chain.

This flag sets --chain=dev, --force-authoring, --rpc-cors=all, --alice, and --tmp flags, unless explicitly overridden. It also disables local peer discovery (see --no-mdns and --discover-local). With this flag some nodes might start with manual seal, producing blocks at certain events (e.g. polkadot-omni-node, which produces blocks at certain intervals dictated by --dev-block-time).

base_path: Option<PathBuf>

Specify custom base path.

log: Vec<String>

Sets a custom logging filter (syntax: <target>=<level>).

Log levels (least to most verbose) are error, warn, info, debug, and trace.

By default, all targets log info. The global log level can be set with -l<level>.

Multiple <target>=<level> entries can be specified and separated by a comma.

Example: --log error,sync=debug,grandpa=warn. Sets Global log level to error, sets sync target to debug and grandpa target to warn.

detailed_log_output: bool

Enable detailed log output.

Includes displaying the log target, log level and thread name.

This is automatically enabled when something is logged with any higher level than info.

disable_log_color: bool

Disable log color output.

enable_log_reloading: bool

Enable feature to dynamically update and reload the log filter.

Be aware that enabling this feature can lead to a performance decrease up to factor six or more. Depending on the global logging level the performance decrease changes.

The system_addLogFilter and system_resetLogFilter RPCs will have no effect with this option not being set.

tracing_targets: Option<String>

Sets a custom profiling filter.

Syntax is the same as for logging (--log).

tracing_receiver: TracingReceiver

Receiver to process tracing messages.

Implementations

impl SharedParams

pub fn base_path(&self) -> Result<Option<BasePath>, Error>

Specify custom base path.

pub fn is_dev(&self) -> bool

Specify the development chain.

pub fn chain_id(&self, is_dev: bool) -> String

Get the chain spec for the parameters provided

pub fn log_filters(&self) -> &[String]

Get the filters for the logging

pub fn detailed_log_output(&self) -> bool

Should the detailed log output be enabled.

pub fn disable_log_color(&self) -> bool

Should the log color output be disabled?

pub fn enable_log_reloading(&self) -> bool

Is log reloading enabled

pub fn tracing_receiver(&self) -> TracingReceiver

Receiver to process tracing messages.

pub fn tracing_targets(&self) -> Option<String>

Comma separated list of targets for tracing.

Trait Implementations

impl Args for SharedParams

fn group_id() -> Option<Id>

Report the [ArgGroup::id][crate::ArgGroup::id] for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate Self.

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to [Command] so it can update self.

impl Clone for SharedParams

fn clone(&self) -> SharedParams

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SharedParams

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

Formats the value using the given formatter.

impl FromArgMatches for SharedParams

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.