Struct Args

pub struct Args {
    pub template_names: Vec<String>,
    pub server_url: String,
    pub show_help: bool,
    pub show_version: bool,
    pub show_author: bool,
}

Struct to parse and gather cli args parsing result.

It should not be used directly to parse cli args, but should be used along crate::parser::ArgsParser, which wraps all the complex parsing logic.

Fields

template_names: Vec<String>

A non-empty list of gitignore template names.

Represented by the provided positional arguments, and required unless any of author, version or help options are given.

server_url: String

The gitignore template generator service url.

Optional value represented by the cli option constant::cli_options::SERVER_URL that takes a string value, and falling back to constant::template_generator::BASE_URL if not provided in cli args.

show_help: bool

The boolean indicator of whether to display help infos or not.

Optional value represented by the cli option constant::cli_options::HELP, and falling back to false if not provided in cli args.

show_version: bool

The boolean indicator of whether to display version infos or not.

Optional value represented by the cli option constant::cli_options::VERSION, and falling back to false if not provided in cli args.

show_author: bool

The boolean indicator of whether to display author infos or not.

Optional value represented by the cli option constant::cli_options::AUTHOR, and falling back to false if not provided in cli args.

Implementations

impl Args

pub fn with_template_names(self, template_names: Vec<String>) -> Self

Sets new value for template_names field.

It needs to be called on struct instance and effectively mutates it.

Arguments

• template_names - The new value to be assigned to template_names field.

Returns

The mutated borrowed instance.

pub fn with_server_url(self, server_url: &str) -> Self

Sets new value for server_url field.

It needs to be called on struct instance and effectively mutates it.

Arguments

• server_url - The new value to be assigned to server_url field.

Returns

The mutated borrowed instance.

Trait Implementations

impl Args for Args

fn group_id() -> Option<Id>

Report the 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 CommandFactory for Args

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 Args

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

Formats the value using the given formatter.

impl Default for Args

fn default() -> Args

Returns the “default value” for a type.

impl FromArgMatches for Args

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 Args

fn parse() -> Self

Parse from std::env::args_os(), 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 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 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.

impl PartialEq for Args

fn eq(&self, other: &Args) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Args