Struct jormungandr::settings::command_arguments::CommandLine

pub struct CommandLine {
    pub log_level: Option<LevelFilter>,
    pub log_format: Option<LogFormat>,
    pub log_output: Option<LogOutput>,
    pub trace_collector_endpoint: Option<Url>,
    pub rewards_report_all: bool,
    pub rest_arguments: RestArguments,
    pub jrpc_arguments: JRpcArguments,
    pub start_arguments: StartArguments,
    pub full_version: bool,
    pub source_version: bool,
    pub storage_check: bool,
}

Fields

log_level: Option<LevelFilter>

Set log messages minimum severity. If not configured anywhere, defaults to “info”.

log_format: Option<LogFormat>

Set format of the log emitted. Can be “json” or “plain”. If not configured anywhere, defaults to “plain”.

log_output: Option<LogOutput>

Set where the log will be emitted. Can be “stdout”, “stderr”, a file path preceeded by ‘@’ (e.g. @./jormungandr.log) or “journald” (linux with systemd only, must be enabled during compilation).

If not configured anywhere, defaults to “stderr”

trace_collector_endpoint: Option<Url>

Enable the OTLP trace data exporter and set the collector’s GRPC endpoint.

rewards_report_all: bool

report all the rewards in the reward distribution history

NOTE: this will slowdown the epoch transition computation and will add add a lot of items for in-memory operations, this is not recommended to set

rest_arguments: RestArguments

jrpc_arguments: JRpcArguments

start_arguments: StartArguments

full_version: bool

display full version details (software version, source version, targets and compiler used)

source_version: bool

display the sources version, allowing to check the source’s hash used to compile this executable. this option is useful for scripting retrieving the logs of the version of this application.

storage_check: bool

Initialize the storage and exit, useful to check that the storage has been set up correctly.

Implementations

impl CommandLine

pub fn load() -> Self

load the command arguments from the command line args

on error during reading the command line arguments, the function will print an error message and will terminate the process.

Trait Implementations

impl Args for CommandLine

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 CommandFactory for CommandLine

fn command<'b>() -> Command

Build a [Command] that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a [Command] that can update self.

impl Debug for CommandLine

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

Formats the value using the given formatter.

impl FromArgMatches for CommandLine

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.

impl Parser for CommandLine

fn parse() -> Self

Parse from std::env::args_os(), exit on error

fn try_parse() -> Result<Self, Error<RichFormatter>>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Selfwhere I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, exit on error

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error<RichFormatter>>where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, exit on error

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error<RichFormatter>>where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.