Struct Args

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

Struct to gather cli args parsing result.

Used by crate::parser::ArgsParser implementations to store parsing result.

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.
• This field does not allow commas in any of its field.

server_url: String

The gitignore template generator service url.

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

generator_uri: String

The gitignore template generator service endpoint uri.

• Optional value represented by the cli option crate::constant::cli_options::GENERATOR_URI that takes a string value, and falling back to crate::constant::template_manager::GENERATOR_URI if not provided in cli args.

lister_uri: String

The gitignore template lister service endpoint uri.

• Optional value represented by the cli option crate::constant::cli_options::LISTER_URI that takes a string value, and falling back to crate::constant::template_manager::LISTER_URI 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 crate::constant::cli_options::HELP, and falling back to false if not provided in cli args.
• Has precedence over version and author options if multiple are given

show_version: bool

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

• Optional value represented by the cli option crate::constant::cli_options::VERSION, and falling back to false if not provided in cli args.
• Has precedence over author option if multiple are given

show_author: bool

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

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

show_list: bool

The boolean indicator of whether to display list of available templates or not.

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

check_template_names: bool

The boolean indicator of whether to enable robust template check or not.

Robust template check allow the script to handle template existence check without reaching the generator endpoint.

• Optional value represented by the cli option crate::constant::cli_options::CHECK, 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.

pub fn with_generator_uri(self, generator_uri: &str) -> Self

Sets new value for generator_uri field.

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

Arguments

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

Returns

The mutated borrowed instance.

pub fn with_lister_uri(self, lister_uri: &str) -> Self

Sets new value for lister_uri field.

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

Arguments

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

Returns

The mutated borrowed instance.

pub fn with_show_list(self, show_list: bool) -> Self

Sets new value for show_list field.

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

Arguments

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

Returns

The mutated borrowed instance.

pub fn with_check_template_names(self, check_template_names: bool) -> Self

Sets new value for check_template_names field.

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

Arguments

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

Returns

The mutated borrowed instance.

Trait Implementations

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 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