Struct CliClientArgs

pub struct CliClientArgs {
    pub hostname: String,
    pub port: u16,
    pub worker_name: String,
    pub verbose: u8,
    pub debug: u8,
    pub trace: u8,
    pub open: bool,
    pub save: bool,
}

Represents command line arguments for a client in a CLI application.

This struct is used to parse and store command line arguments specific to the client part of an application. It leverages the clap crate for argument parsing.

Fields

• hostname: A string specifying the hostname. Defaults to “localhost”.
• port: A 16-bit unsigned integer specifying the port number. Defaults to 8787.
• worker_name: A string specifying the name of the worker. Defaults to “worker”.

Example

Command line usage might look like this:

worker -H 192.168.1.0 -P 8787 -N my_group_name

Fields

hostname: String

Optional: The hostname of the client. Default: “localhost”

port: u16

Optional: The port number to connect on. Default: 8787

worker_name: String

Optional: The name of the worker. Default: “worker”

verbose: u8

Optional: Add a flag to enable/disable logging. Default: 0

debug: u8

Optional: Add a flag to enable/disable debug mode. Default: 0

trace: u8

Optional: Add a flag to enable/disable trace mode. Default: 0

open: bool

Optional: Add a flag to enable/disable opening the browser. Default: false

save: bool

Optional: Add a flag to save the image to a file. Default: false

Trait Implementations

impl Args for CliClientArgs

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 Clone for CliClientArgs

fn clone(&self) -> CliClientArgs

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl CommandFactory for CliClientArgs

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 CliClientArgs

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

Formats the value using the given formatter.

impl FromArgMatches for CliClientArgs

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 CliClientArgs

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.