Struct Spec

pub struct Spec<C> { /* private fields */ }

Option/argument specification.

Implementations

impl<C> Spec<C>

pub fn is_capture_rest(&self) -> bool

Return a boolean indicating whether this arg spec is configured to capture all the remaining arguments.

pub fn is_exit(&self) -> bool

Return boolean indicating whether this arg spec will abort the parser.

pub fn is_opt(&self) -> bool

Return boolean indicating whether this arg spec represents an “option”.

“Options” come in two forms: short or long

Short options are in the form “”, like “-h”, “-f”.

Long options are in the form “”, like “–help”, –file“.

This function will return true for either form.

pub fn is_pos(&self) -> bool

Return boolean indicating whether this arg is a positional argument.

pub fn is_req(&self) -> bool

pub fn is_hidden(&self) -> bool

pub fn get_nargs(&self) -> usize

pub fn req_args(&self) -> bool

pub fn get_opts_usage_str(&self) -> String

pub fn get_usage_str(&self) -> String

Generate a string that shows a representation of this argument specification suitable for use in a “Usage: “ string.

Required parameters are enclosed by ‘<’ and ‘>’ charcters. Optional parameters are enclossed by ‘[’ and ‘]’ characters.

pub fn get_help_title_str(&self) -> String

pub fn get_help_text(&self) -> &Vec<String>