Struct LeoExample

pub struct LeoExample {
    pub(crate) name: String,
    pub(crate) network: String,
    pub(crate) endpoint: String,
}

Initialize a new Leo example.

Fields

name: String

network: String

endpoint: String

Trait Implementations

impl Args for LeoExample

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 via [FromArgMatches::from_arg_matches_mut]

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

Append to [Command] so it can instantiate self via [FromArgMatches::update_from_arg_matches_mut]

impl Command for LeoExample

type Input = <LeoNew as Command>::Output

If the current command requires running another command beforehand and needs its output result, this is where the result type is defined. Example: type Input: ::Out

type Output = ()

Defines the output of this command, which may be used as Input for another command. If this command is not used as a prelude for another command, this field may be left empty.

fn prelude(&self, context: Context) -> Result<Self::Input>

Runs the prelude and returns the Input of the current command.

fn apply(self, context: Context, _: Self::Input) -> Result<Self::Output>

where Self: Sized,

Runs the main operation of this command. This function is run within context of ‘execute’ function, which sets logging and timers.

fn log_span(&self) -> Span

Adds a span to the logger via tracing::span. Because of the specifics of the macro implementation, it is not possible to set the span name with a non-literal i.e. a dynamic variable even if this variable is a &’static str.

fn execute(self, context: Context) -> Result<Self::Output>

where Self: Sized,

A wrapper around the apply method. This function sets up tracing, timing, and the context.

fn try_execute(self, context: Context) -> Result<()>

where Self: Sized,

Executes command but empty the result. Comes in handy where there’s a need to make match arms compatible while keeping implementation-specific output possible. Errors however are all of the type Error

impl CommandFactory for LeoExample

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 LeoExample

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

Formats the value using the given formatter.

impl FromArgMatches for LeoExample

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 LeoExample

fn parse() -> Self

Parse from std::env::args_os(), [exit][Error::exit] on error.

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

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

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, [exit][Error::exit] on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

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][Error::exit] on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.