Struct Helper

pub struct Helper { /* private fields */ }

Helper

Implementations

impl Helper

pub fn name(&self) -> &String

name

pub fn version(&self) -> &String

version

pub fn desc(&self) -> &String

description

pub fn authors(&self) -> &Vec<(String, String)>

name, email

pub fn addrs(&self) -> &Vec<(String, String)>

url_name, url

impl Helper

pub fn current_cmd(&self) -> Option<&String>

pub fn current_cmd_str(&self) -> Option<&str>

pub fn current_cmd_ref(&self) -> &Option<String>

pub fn current_exe(&self) -> Option<&String>

pub fn current_dir(&self) -> Option<&String>

pub fn home_dir(&self) -> Option<&String>

pub fn temp_dir(&self) -> &String

pub fn args_len(&self) -> &usize

You can do something if the length of arguments satisfys a condition.

Example: Print the help message when args.len() is 0.

let helper= {
    ...
};
if helper.args_len() == 0 
{
    helper.help_exit(0);
}

pub fn as_helps(&self) -> &Helps

pub fn as_mut_helps(&mut self) -> &mut Helps

impl Helper

pub fn exit(&self, status: i32)

exit with the status

pub fn ver(&self) -> &String

format!("{} {}", self.name(), self.version())

pub fn ver_exit(&self, status: i32)

print ver(self.ver) message and exit with the status

pub fn err<E>(&self, error: E) -> String

where E: AsRef<str> + Display,

format!("ERROR:\n {}\n\n", error)

pub fn err_exit<E>(&self, error: E, status: i32)

where E: AsRef<str> + Display,

print error(self.err(error)) message to stderr and exit with the status

pub fn err_line_print(&self, msg: &str, line_color: Color)

print error message line(2) with Red color(fg)

pub fn help(&self) -> String

main’s help mesage

pub fn help_exit(&self, status: i32)

print main’s help message and exit with the status

pub fn help_err<E>(&self, error: E) -> String

where E: AsRef<str> + Display,

self.err(error) + self.help()

pub fn help_err_exit<E>(&self, error: E, status: i32)

where E: AsRef<str> + Display,

print error and help message(self.help_err(error)) to stderr and exit with the status

pub fn help_cmd(&self, cmd_name: &Option<String>) -> String

get sub_command’s help message

pub fn help_cmd_exit(&self, cmd_name: &Option<String>, status: i32)

print sub_command’s help message and exit with the status

pub fn help_cmd_err<E>(&self, cmd_name: &Option<String>, error: E) -> String

where E: AsRef<str> + Display,

self.err(error) + self.help_cmd(cmd_name)

pub fn help_cmd_err_exit<E>( &self, cmd_name: &Option<String>, error: E, status: i32, )

where E: AsRef<str> + Display,

print error and sub_command’s help message to stderr,s exit with the status

Trait Implementations

impl Debug for Helper

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

Formats the value using the given formatter.

impl Default for Helper

fn default() -> Helper

Returns the “default value” for a type.