Struct sc_cli::SharedParams

pub struct SharedParams {
    pub chain: Option<String>,
    pub dev: bool,
    pub base_path: Option<PathBuf>,
    pub log: Vec<String>,
    pub disable_log_color: bool,
    pub disable_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.

base_path: Option<PathBuf>

Specify custom base path.

log: Vec<String>

Sets a custom logging filter. Syntax is =, e.g. -lsync=debug.

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.

disable_log_color: bool

Disable log color output.

disable_log_reloading: bool

Disable feature to dynamically update and reload the log filter.

By default this feature is enabled, however it leads to a small performance decrease. The system_addLogFilter and system_resetLogFilter RPCs will have no effect with this option set.

tracing_targets: Option<String>

Sets a custom profiling filter. Syntax is the same as for logging: =

tracing_receiver: TracingReceiver

Receiver to process tracing messages.

Implementations

impl SharedParams

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

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 disable_log_color(&self) -> bool

Should the log color output be disabled?

pub fn is_log_filter_reloading_disabled(&self) -> bool

Is log reloading disabled

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

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

Formats the value using the given formatter.

impl StructOpt for SharedParams

fn clap<'a, 'b>() -> App<'a, 'b>

Returns clap::App corresponding to the struct.

fn from_clap(matches: &ArgMatches<'_>) -> Self

Builds the struct from clap::ArgMatches. It’s guaranteed to succeed if matches originates from an App generated by StructOpt::clap called on the same type, otherwise it must panic.

pub fn from_args() -> Self

Builds the struct from the command line arguments (std::env::args_os). Calls clap::Error::exit on failure, printing the error message and aborting the program.

pub fn from_args_safe() -> Result<Self, Error>

Builds the struct from the command line arguments (std::env::args_os). Unlike StructOpt::from_args, returns clap::Error on failure instead of aborting the program, so calling .exit is up to you.

pub fn from_iter<I>(iter: I) -> Self where
    I: IntoIterator,
    <I as IntoIterator>::Item: Into<OsString>,
    <I as IntoIterator>::Item: Clone, 

Gets the struct from any iterator such as a Vec of your making. Print the error message and quit the program in case of failure.

pub fn from_iter_safe<I>(iter: I) -> Result<Self, Error> where
    I: IntoIterator,
    <I as IntoIterator>::Item: Into<OsString>,
    <I as IntoIterator>::Item: Clone, 

Gets the struct from any iterator such as a Vec of your making.

impl StructOptInternal for SharedParams

fn augment_clap<'a, 'b>(app: App<'a, 'b>) -> App<'a, 'b>

fn is_subcommand() -> bool

pub fn from_subcommand(
    _sub: (&'b str, Option<&'b ArgMatches<'a>>)
) -> Option<Self>