Struct drml::cli::Cli

pub struct Cli {
    pub subcommand: Option<Subcommand>,
    pub run: Run,
}

An overarching CLI command definition.

Fields

subcommand: Option<Subcommand>

Possible subcommand with parameters.

run: Run

Trait Implementations

impl Debug for Cli

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

Formats the value using the given formatter.

impl StructOpt for Cli

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.

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.

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.

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.

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 SubstrateCli for Cli

fn impl_name() -> String

Implementation name.

fn impl_version() -> String

Implementation version.

fn executable_name() -> String

Executable file name.

fn description() -> String

Executable file description.

fn author() -> String

Executable file author.

fn support_url() -> String

Support URL.

fn copyright_start_year() -> i32

Copyright starting year (x-current year)

fn native_runtime_version(spec: &Box<dyn ChainSpec>) -> &'static RuntimeVersion

Native runtime version.

fn load_spec(&self, id: &str) -> Result<Box<dyn ChainSpec>, String>

Chain spec factory

fn from_args() -> Self where
    Self: StructOpt, 

Helper function used to parse the command line arguments. This is the equivalent of structopt’s from_iter() except that it takes a VersionInfo argument to provide the name of the application, author, “about” and version. It will also set AppSettings::GlobalVersion.

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

Helper function used to parse the command line arguments. This is the equivalent of structopt’s from_iter() except that it takes a VersionInfo argument to provide the name of the application, author, “about” and version. It will also set AppSettings::GlobalVersion.

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

Helper function used to parse the command line arguments. This is the equivalent of structopt’s from_iter() except that it takes a VersionInfo argument to provide the name of the application, author, “about” and version. It will also set AppSettings::GlobalVersion.

fn client_id() -> String

Returns the client ID: {impl_name}/v{impl_version}

fn create_configuration<T, DVC>(
    &self,
    command: &T,
    tokio_handle: Handle
) -> Result<Configuration, Error> where
    T: CliConfiguration<DVC>,
    DVC: DefaultConfigurationValues, 

Only create a Configuration for the command provided in argument

fn create_runner<T>(&self, command: &T) -> Result<Runner<Self>, Error> where
    T: CliConfiguration<()>, 

Create a runner for the command provided in argument. This will create a Configuration and a tokio runtime

fn create_runner_with_logger_hook<T, F>(
    &self,
    command: &T,
    logger_hook: F
) -> Result<Runner<Self>, Error> where
    T: CliConfiguration<()>,
    F: FnOnce(&mut LoggerBuilder, &Configuration), 

Create a runner for the command provided in argument. The logger_hook can be used to setup a custom profiler or update the logger configuration before it is initialized.