Enum zebrad::commands::ZebradCmd

pub enum ZebradCmd {
    CopyState(CopyStateCmd),
    Download(DownloadCmd),
    Generate(GenerateCmd),
    Help(Help<Self>),
    Start(StartCmd),
    TipHeight(TipHeightCmd),
    Version(VersionCmd),
}

Zebrad Subcommands

Variants

CopyState(CopyStateCmd)

The copy-state subcommand, used to debug cached chain state

Download(DownloadCmd)

The download subcommand

Generate(GenerateCmd)

The generate subcommand

Help(Help<Self>)

The help subcommand

Start(StartCmd)

The start subcommand

TipHeight(TipHeightCmd)

The tip-height subcommand

Version(VersionCmd)

The version subcommand

Implementations

impl ZebradCmd

pub(crate) fn is_server(&self) -> bool

Returns true if this command is a server command.

Servers load extra components, and use the configured tracing filter.

For example, Start acts as a Zcash node.

pub(crate) fn default_tracing_filter(&self, verbose: bool) -> &'static str

Returns the default log level for this command, based on the verbose command line flag.

Some commands need to be quiet by default.

Trait Implementations

impl Command for ZebradCmd

fn name() -> &'static str

Name of this program as a string

fn description() -> &'static str

Description of this program

fn version() -> &'static str

Version of this program

fn authors() -> &'static str

Authors of this program

fn subcommand_usage(command: &str) -> Option<Usage>

get usage information for the named subcommand

fn from_args<A>(into_args: A) -> Selfwhere
    A: IntoIterator<Item = String>,

Parse command-line arguments from a string iterator

fn from_env_args() -> Self

Parse command-line arguments from the environment

fn print_usage_and_exit(args: &[String]) -> !

Print usage information and exit

impl Configurable<ZebradConfig> for ZebradCmd

This trait allows you to define how application configuration is loaded.

fn config_path(&self) -> Option<PathBuf>

Location of the configuration file

fn process_config(
    &self,
    config: ZebradConfig
) -> Result<ZebradConfig, FrameworkError>

Apply changes to the config after it’s been loaded, e.g. overriding values in a config file using command-line options.

This can be safely deleted if you don’t want to override config settings from command-line options.

impl Debug for ZebradCmd

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

Formats the value using the given formatter.

impl Options for ZebradCmd

fn parse<__S: AsRef<str>>(_parser: &mut Parser<'_, __S>) -> Result<Self, Error>

Parses arguments until the given parser is exhausted or until an error is encountered.

fn command_name(&self) -> Option<&'static str>

Returns the name of a parsed command, if present.

fn help_requested(&self) -> bool

Returns whether the user supplied a “help” option to request usage information about the program or any contained subcommands.

fn parse_command<__S: AsRef<str>>(
    name: &str,
    _parser: &mut Parser<'_, __S>
) -> Result<Self, Error>

Parses options for the named command.

fn usage() -> &'static str

Returns a string showing usage and help for each supported option.

fn command_list() -> Option<&'static str>

Returns a string listing available commands and help text.

fn command_usage(name: &str) -> Option<&'static str>

Returns a usage string for the named command.

fn parse_args<S>(args: &[S], style: ParsingStyle) -> Result<Self, Error>where
    S: AsRef<str>,

Parses arguments received from the command line.

fn parse_args_or_exit(style: ParsingStyle) -> Self

Parses arguments from the environment.

fn parse_args_default_or_exit() -> Self

Parses arguments from the environment, using the default parsing style.

fn parse_args_default<S>(args: &[S]) -> Result<Self, Error>where
    S: AsRef<str>,

Parses arguments received from the command line, using the default parsing style.

impl Runnable for ZebradCmd

fn run(&self)

Run this Runnable