Mirrors/clap
2
0
Fork 0
mirror of https://github.com/clap-rs/clap synced 2024-12-14 23:02:31 +00:00
Code Issues Projects Releases Packages Wiki Activity

Allow rustc inline small functions across crates

Browse source
This commit is contained in:
CreepySkeleton 2020-04-19 17:00:13 +03:00
parent aae96236b2
commit f149f35da4
5 changed files with 81 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
src/build/app/mod.rs
View file

@ -95,11 +95,13 @@ pub struct App<'b> {
impl<'b> App<'b> { impl<'b> App<'b> {
/// Get the name of the app /// Get the name of the app
#[inline]
pub fn get_name(&self) -> &str { pub fn get_name(&self) -> &str {
&self.name &self.name
} }
/// Get the name of the binary /// Get the name of the binary
#[inline]
pub fn get_bin_name(&self) -> Option<&str> { pub fn get_bin_name(&self) -> Option<&str> {
self.bin_name.as_deref() self.bin_name.as_deref()
} }
@ -110,11 +112,13 @@ impl<'b> App<'b> {
} }
/// Get the help message specified via [`App::about`] /// Get the help message specified via [`App::about`]
#[inline]
pub fn get_about(&self) -> Option<&str> { pub fn get_about(&self) -> Option<&str> {
self.about.as_deref() self.about.as_deref()
} }
/// Iterate through the *visible* aliases for this subcommand. /// Iterate through the *visible* aliases for this subcommand.
#[inline]
pub fn get_visible_aliases(&self) -> impl Iterator<Item = &str> { pub fn get_visible_aliases(&self) -> impl Iterator<Item = &str> {
self.aliases self.aliases
.as_ref() .as_ref()
@ -123,6 +127,7 @@ impl<'b> App<'b> {
} }
/// Iterate through the set of *all* the aliases for this subcommand, both visible and hidden. /// Iterate through the set of *all* the aliases for this subcommand, both visible and hidden.
#[inline]
pub fn get_all_aliases(&self) -> impl Iterator<Item = &str> { pub fn get_all_aliases(&self) -> impl Iterator<Item = &str> {
self.aliases self.aliases
.as_ref() .as_ref()
@ -131,16 +136,19 @@ impl<'b> App<'b> {
} }
/// Get the list of subcommands /// Get the list of subcommands
#[inline]
pub fn get_subcommands(&self) -> &[App<'b>] { pub fn get_subcommands(&self) -> &[App<'b>] {
&self.subcommands &self.subcommands
} }
/// Get the list of subcommands /// Get the list of subcommands
#[inline]
pub fn get_subcommands_mut(&mut self) -> &mut [App<'b>] { pub fn get_subcommands_mut(&mut self) -> &mut [App<'b>] {
&mut self.subcommands &mut self.subcommands
} }
/// Get the list of arguments /// Get the list of arguments
#[inline]
pub fn get_arguments(&self) -> &[Arg<'b>] { pub fn get_arguments(&self) -> &[Arg<'b>] {
&self.args.args &self.args.args
} }
@ -168,11 +176,13 @@ impl<'b> App<'b> {
} }
/// Check if the setting was set either with [`App::setting`] or [`App::global_setting`] /// Check if the setting was set either with [`App::setting`] or [`App::global_setting`]
#[inline]
pub fn is_set(&self, s: AppSettings) -> bool { pub fn is_set(&self, s: AppSettings) -> bool {
self.settings.is_set(s) || self.g_settings.is_set(s) self.settings.is_set(s) || self.g_settings.is_set(s)
} }
/// Check whether this app has subcommands /// Check whether this app has subcommands
#[inline]
pub fn has_subcommands(&self) -> bool { pub fn has_subcommands(&self) -> bool {
!self.subcommands.is_empty() !self.subcommands.is_empty()
} }
@ -531,6 +541,7 @@ impl<'b> App<'b> {
/// ``` /// ```
/// [``]: ./struct..html /// [``]: ./struct..html
/// [`AppSettings`]: ./enum.AppSettings.html /// [`AppSettings`]: ./enum.AppSettings.html
#[inline]
pub fn setting(mut self, setting: AppSettings) -> Self { pub fn setting(mut self, setting: AppSettings) -> Self {
self.settings.set(setting); self.settings.set(setting);
self self
@ -551,6 +562,7 @@ impl<'b> App<'b> {
/// [``]: ./struct..html /// [``]: ./struct..html
/// [`AppSettings`]: ./enum.AppSettings.html /// [`AppSettings`]: ./enum.AppSettings.html
/// [global]: ./struct.App.html#method.global_setting /// [global]: ./struct.App.html#method.global_setting
#[inline]
pub fn unset_setting(mut self, setting: AppSettings) -> Self { pub fn unset_setting(mut self, setting: AppSettings) -> Self {
self.settings.unset(setting); self.settings.unset(setting);
self.g_settings.unset(setting); self.g_settings.unset(setting);
@ -572,6 +584,7 @@ impl<'b> App<'b> {
/// # ; /// # ;
/// ``` /// ```
/// [`AppSettings`]: ./enum.AppSettings.html /// [`AppSettings`]: ./enum.AppSettings.html
#[inline]
pub fn global_setting(mut self, setting: AppSettings) -> Self { pub fn global_setting(mut self, setting: AppSettings) -> Self {
self.settings.set(setting); self.settings.set(setting);
self.g_settings.set(setting); self.g_settings.set(setting);
@ -594,6 +607,7 @@ impl<'b> App<'b> {
/// ``` /// ```
/// [`AppSettings`]: ./enum.AppSettings.html /// [`AppSettings`]: ./enum.AppSettings.html
/// [global]: ./struct.App.html#method.global_setting /// [global]: ./struct.App.html#method.global_setting
#[inline]
pub fn unset_global_setting(mut self, setting: AppSettings) -> Self { pub fn unset_global_setting(mut self, setting: AppSettings) -> Self {
self.settings.unset(setting); self.settings.unset(setting);
self.g_settings.unset(setting); self.g_settings.unset(setting);
@ -625,6 +639,7 @@ impl<'b> App<'b> {
/// .set_term_width(80) /// .set_term_width(80)
/// # ; /// # ;
/// ``` /// ```
#[inline]
pub fn set_term_width(mut self, width: usize) -> Self { pub fn set_term_width(mut self, width: usize) -> Self {
self.term_w = Some(width); self.term_w = Some(width);
self self
@ -653,6 +668,7 @@ impl<'b> App<'b> {
/// .max_term_width(100) /// .max_term_width(100)
/// # ; /// # ;
/// ``` /// ```
#[inline]
pub fn max_term_width(mut self, w: usize) -> Self { pub fn max_term_width(mut self, w: usize) -> Self {
self.max_w = Some(w); self.max_w = Some(w);
self self
@ -693,12 +709,14 @@ impl<'b> App<'b> {
/// Set a custom section heading for future args. Every call to arg will /// Set a custom section heading for future args. Every call to arg will
/// have this header (instead of its default header) until a subsequent /// have this header (instead of its default header) until a subsequent
/// call to help_heading /// call to help_heading
#[inline]
pub fn help_heading(mut self, heading: &'b str) -> Self { pub fn help_heading(mut self, heading: &'b str) -> Self {
self.help_headings.push(Some(heading)); self.help_headings.push(Some(heading));
self self
} }
/// Stop using custom section headings. /// Stop using custom section headings.
#[inline]
pub fn stop_custom_headings(mut self) -> Self { pub fn stop_custom_headings(mut self) -> Self {
self.help_headings.push(None); self.help_headings.push(None);
self self
@ -854,6 +872,7 @@ impl<'b> App<'b> {
/// assert!(m.subcommand_matches("module").is_some()); /// assert!(m.subcommand_matches("module").is_some());
/// assert!(m.subcommand_matches("module").unwrap().subcommand_matches("install").is_some()); /// assert!(m.subcommand_matches("module").unwrap().subcommand_matches("install").is_some());
/// ``` /// ```
#[inline]
pub fn replace(mut self, name: &'b str, target: &'b [&'b str]) -> Self { pub fn replace(mut self, name: &'b str, target: &'b [&'b str]) -> Self {
self.replacers.insert(name, target); self.replacers.insert(name, target);
self self
@ -892,6 +911,7 @@ impl<'b> App<'b> {
/// # ; /// # ;
/// ``` /// ```
/// [`ArgGroup`]: ./struct.ArgGroup.html /// [`ArgGroup`]: ./struct.ArgGroup.html
#[inline]
pub fn group(mut self, group: ArgGroup<'b>) -> Self { pub fn group(mut self, group: ArgGroup<'b>) -> Self {
self.groups.push(group); self.groups.push(group);
self self
@ -945,6 +965,7 @@ impl<'b> App<'b> {
/// ``` /// ```
/// [``]: ./struct..html /// [``]: ./struct..html
/// [`App`]: ./struct.App.html /// [`App`]: ./struct.App.html
#[inline]
pub fn subcommand(mut self, subcmd: App<'b>) -> Self { pub fn subcommand(mut self, subcmd: App<'b>) -> Self {
self.subcommands.push(subcmd); self.subcommands.push(subcmd);
self self
@ -1023,6 +1044,7 @@ impl<'b> App<'b> {
/// alpha Some help and text /// alpha Some help and text
/// ``` /// ```
/// [``]: ./struct..html /// [``]: ./struct..html
#[inline]
pub fn display_order(mut self, ord: usize) -> Self { pub fn display_order(mut self, ord: usize) -> Self {
self.disp_ord = ord; self.disp_ord = ord;
self self
@ -1243,6 +1265,7 @@ impl<'b> App<'b> {
/// .get_matches(); /// .get_matches();
/// ``` /// ```
/// [`env::args_os`]: https://doc.rust-lang.org/std/env/fn.args_os.html /// [`env::args_os`]: https://doc.rust-lang.org/std/env/fn.args_os.html
#[inline]
pub fn get_matches(self) -> ArgMatches { pub fn get_matches(self) -> ArgMatches {
self.get_matches_from(&mut env::args_os()) self.get_matches_from(&mut env::args_os())
} }
@ -1307,6 +1330,7 @@ impl<'b> App<'b> {
/// [`clap::Result`]: ./type.Result.html /// [`clap::Result`]: ./type.Result.html
/// [`clap::Error`]: ./struct.Error.html /// [`clap::Error`]: ./struct.Error.html
/// [`kind`]: ./struct.Error.html /// [`kind`]: ./struct.Error.html
#[inline]
pub fn try_get_matches(self) -> ClapResult<ArgMatches> { pub fn try_get_matches(self) -> ClapResult<ArgMatches> {
// Start the parsing // Start the parsing
self.try_get_matches_from(&mut env::args_os()) self.try_get_matches_from(&mut env::args_os())

51
src/build/arg/mod.rs
View file

@ -90,36 +90,43 @@ pub struct Arg<'help> {
/// Getters /// Getters
impl<'help> Arg<'help> { impl<'help> Arg<'help> {
/// Get the name o the argument /// Get the name o the argument
#[inline]
pub fn get_name(&self) -> &str { pub fn get_name(&self) -> &str {
&self.name &self.name
} }
/// Get the help specified for this argument, if any /// Get the help specified for this argument, if any
#[inline]
pub fn get_help(&self) -> Option<&str> { pub fn get_help(&self) -> Option<&str> {
self.help self.help
} }
/// Get the help heading specified for this argument, if any /// Get the help heading specified for this argument, if any
#[inline]
pub fn get_help_heading(&self) -> Option<&str> { pub fn get_help_heading(&self) -> Option<&str> {
self.help_heading self.help_heading
} }
/// Get the short option name for this argument, if any /// Get the short option name for this argument, if any
#[inline]
pub fn get_short(&self) -> Option<char> { pub fn get_short(&self) -> Option<char> {
self.short self.short
} }
/// Get the long option name for this argument, if any /// Get the long option name for this argument, if any
#[inline]
pub fn get_long(&self) -> Option<&str> { pub fn get_long(&self) -> Option<&str> {
self.long self.long
} }
/// Get the list of the possible values for this argument, if any /// Get the list of the possible values for this argument, if any
#[inline]
pub fn get_possible_values(&self) -> Option<&[&str]> { pub fn get_possible_values(&self) -> Option<&[&str]> {
self.possible_vals.as_deref() self.possible_vals.as_deref()
} }
/// Get the index of this argument, if any /// Get the index of this argument, if any
#[inline]
pub fn get_index(&self) -> Option<u64> { pub fn get_index(&self) -> Option<u64> {
self.index self.index
} }
@ -153,6 +160,7 @@ impl<'help> Arg<'help> {
/// ``` /// ```
/// [`Arg::takes_value(true)`]: ./struct.Arg.html#method.takes_value /// [`Arg::takes_value(true)`]: ./struct.Arg.html#method.takes_value
/// [`Arg`]: ./struct.Arg.html /// [`Arg`]: ./struct.Arg.html
#[inline]
pub fn with_name(n: &'help str) -> Self { pub fn with_name(n: &'help str) -> Self {
Arg { Arg {
id: n.into(), id: n.into(),
@ -272,6 +280,7 @@ impl<'help> Arg<'help> {
/// assert!(m.is_present("config")); /// assert!(m.is_present("config"));
/// ``` /// ```
/// [`short`]: ./struct.Arg.html#method.short /// [`short`]: ./struct.Arg.html#method.short
#[inline]
pub fn short(mut self, s: char) -> Self { pub fn short(mut self, s: char) -> Self {
if s == '-' { if s == '-' {
panic!("short option name cannot be `-`"); panic!("short option name cannot be `-`");
@ -316,6 +325,7 @@ impl<'help> Arg<'help> {
/// ///
/// assert!(m.is_present("cfg")); /// assert!(m.is_present("cfg"));
/// ``` /// ```
#[inline]
pub fn long(mut self, l: &'help str) -> Self { pub fn long(mut self, l: &'help str) -> Self {
self.long = Some(l.trim_start_matches(|c| c == '-')); self.long = Some(l.trim_start_matches(|c| c == '-'));
self self
@ -491,6 +501,7 @@ impl<'help> Arg<'help> {
/// -V, --version Prints version information /// -V, --version Prints version information
/// ``` /// ```
/// [`Arg::long_help`]: ./struct.Arg.html#method.long_help /// [`Arg::long_help`]: ./struct.Arg.html#method.long_help
#[inline]
pub fn help(mut self, h: &'help str) -> Self { pub fn help(mut self, h: &'help str) -> Self {
self.help = Some(h); self.help = Some(h);
self self
@ -562,6 +573,7 @@ impl<'help> Arg<'help> {
/// Prints version information /// Prints version information
/// ``` /// ```
/// [`Arg::help`]: ./struct.Arg.html#method.help /// [`Arg::help`]: ./struct.Arg.html#method.help
#[inline]
pub fn long_help(mut self, h: &'help str) -> Self { pub fn long_help(mut self, h: &'help str) -> Self {
self.long_help = Some(h); self.long_help = Some(h);
self self
@ -932,6 +944,7 @@ impl<'help> Arg<'help> {
/// assert!(res.is_err()); /// assert!(res.is_err());
/// assert_eq!(res.unwrap_err().kind, ErrorKind::ArgumentConflict); /// assert_eq!(res.unwrap_err().kind, ErrorKind::ArgumentConflict);
/// ``` /// ```
#[inline]
pub fn exclusive(mut self, exclusive: bool) -> Self { pub fn exclusive(mut self, exclusive: bool) -> Self {
self.exclusive = exclusive; self.exclusive = exclusive;
self self
@ -1574,6 +1587,7 @@ impl<'help> Arg<'help> {
/// [`Arg::multiple(true)`]: ./struct.Arg.html#method.multiple /// [`Arg::multiple(true)`]: ./struct.Arg.html#method.multiple
/// [`App`]: ./struct.App.html /// [`App`]: ./struct.App.html
/// [`panic!`]: https://doc.rust-lang.org/std/macro.panic!.html /// [`panic!`]: https://doc.rust-lang.org/std/macro.panic!.html
#[inline]
pub fn index(mut self, idx: u64) -> Self { pub fn index(mut self, idx: u64) -> Self {
self.index = Some(idx); self.index = Some(idx);
self self
@ -1624,6 +1638,7 @@ impl<'help> Arg<'help> {
/// [`min_values`]: ./struct.Arg.html#method.min_values /// [`min_values`]: ./struct.Arg.html#method.min_values
/// [`number_of_values`]: ./struct.Arg.html#method.number_of_values /// [`number_of_values`]: ./struct.Arg.html#method.number_of_values
/// [`max_values`]: ./struct.Arg.html#method.max_values /// [`max_values`]: ./struct.Arg.html#method.max_values
#[inline]
pub fn value_terminator(mut self, term: &'help str) -> Self { pub fn value_terminator(mut self, term: &'help str) -> Self {
self.setb(ArgSettings::TakesValue); self.setb(ArgSettings::TakesValue);
self.terminator = Some(term); self.terminator = Some(term);
@ -1870,6 +1885,7 @@ impl<'help> Arg<'help> {
/// assert_eq!(res.unwrap_err().kind, ErrorKind::WrongNumberOfValues); /// assert_eq!(res.unwrap_err().kind, ErrorKind::WrongNumberOfValues);
/// ``` /// ```
/// [`Arg::multiple(true)`]: ./struct.Arg.html#method.multiple /// [`Arg::multiple(true)`]: ./struct.Arg.html#method.multiple
#[inline]
pub fn number_of_values(mut self, qty: u64) -> Self { pub fn number_of_values(mut self, qty: u64) -> Self {
self.setb(ArgSettings::TakesValue); self.setb(ArgSettings::TakesValue);
self.num_vals = Some(qty); self.num_vals = Some(qty);
@ -2017,6 +2033,8 @@ impl<'help> Arg<'help> {
/// assert_eq!(res.unwrap_err().kind, ErrorKind::UnknownArgument); /// assert_eq!(res.unwrap_err().kind, ErrorKind::UnknownArgument);
/// ``` /// ```
/// [`Arg::multiple(true)`]: ./struct.Arg.html#method.multiple /// [`Arg::multiple(true)`]: ./struct.Arg.html#method.multiple
#[inline]
#[inline]
pub fn max_values(mut self, qty: u64) -> Self { pub fn max_values(mut self, qty: u64) -> Self {
self.setb(ArgSettings::TakesValue); self.setb(ArgSettings::TakesValue);
self.setb(ArgSettings::MultipleValues); self.setb(ArgSettings::MultipleValues);
@ -2081,6 +2099,7 @@ impl<'help> Arg<'help> {
/// assert_eq!(res.unwrap_err().kind, ErrorKind::TooFewValues); /// assert_eq!(res.unwrap_err().kind, ErrorKind::TooFewValues);
/// ``` /// ```
/// [`Arg::multiple(true)`]: ./struct.Arg.html#method.multiple /// [`Arg::multiple(true)`]: ./struct.Arg.html#method.multiple
#[inline]
pub fn min_values(mut self, qty: u64) -> Self { pub fn min_values(mut self, qty: u64) -> Self {
self.min_vals = Some(qty); self.min_vals = Some(qty);
self.setting(ArgSettings::TakesValue) self.setting(ArgSettings::TakesValue)
@ -2109,6 +2128,7 @@ impl<'help> Arg<'help> {
/// ``` /// ```
/// [`Arg::use_delimiter(true)`]: ./struct.Arg.html#method.use_delimiter /// [`Arg::use_delimiter(true)`]: ./struct.Arg.html#method.use_delimiter
/// [`Arg::takes_value(true)`]: ./struct.Arg.html#method.takes_value /// [`Arg::takes_value(true)`]: ./struct.Arg.html#method.takes_value
#[inline]
pub fn value_delimiter(mut self, d: &str) -> Self { pub fn value_delimiter(mut self, d: &str) -> Self {
self.unsetb(ArgSettings::ValueDelimiterNotSet); self.unsetb(ArgSettings::ValueDelimiterNotSet);
self.setb(ArgSettings::TakesValue); self.setb(ArgSettings::TakesValue);
@ -2324,6 +2344,7 @@ impl<'help> Arg<'help> {
/// [`Arg::takes_value(true)`]: ./struct.Arg.html#method.takes_value /// [`Arg::takes_value(true)`]: ./struct.Arg.html#method.takes_value
/// [`ArgMatches::is_present`]: ./struct.ArgMatches.html#method.is_present /// [`ArgMatches::is_present`]: ./struct.ArgMatches.html#method.is_present
/// [`Arg::default_value_if`]: ./struct.Arg.html#method.default_value_if /// [`Arg::default_value_if`]: ./struct.Arg.html#method.default_value_if
#[inline]
pub fn default_value(self, val: &'help str) -> Self { pub fn default_value(self, val: &'help str) -> Self {
self.default_values_os(&[OsStr::from_bytes(val.as_bytes())]) self.default_values_os(&[OsStr::from_bytes(val.as_bytes())])
} }
@ -2332,12 +2353,14 @@ impl<'help> Arg<'help> {
/// only using [`OsStr`]s instead. /// only using [`OsStr`]s instead.
/// [`Arg::default_value`]: ./struct.Arg.html#method.default_value /// [`Arg::default_value`]: ./struct.Arg.html#method.default_value
/// [`OsStr`]: https://doc.rust-lang.org/std/ffi/struct.OsStr.html /// [`OsStr`]: https://doc.rust-lang.org/std/ffi/struct.OsStr.html
#[inline]
pub fn default_value_os(self, val: &'help OsStr) -> Self { pub fn default_value_os(self, val: &'help OsStr) -> Self {
self.default_values_os(&[val]) self.default_values_os(&[val])
} }
/// Like [`Arg::default_value'] but for args taking multiple values /// Like [`Arg::default_value'] but for args taking multiple values
/// [`Arg::default_value`]: ./struct.Arg.html#method.default_value /// [`Arg::default_value`]: ./struct.Arg.html#method.default_value
#[inline]
pub fn default_values(self, vals: &[&'help str]) -> Self { pub fn default_values(self, vals: &[&'help str]) -> Self {
let vals_vec: Vec<_> = vals let vals_vec: Vec<_> = vals
.iter() .iter()
@ -2350,6 +2373,7 @@ impl<'help> Arg<'help> {
/// only using [`OsStr`]s instead. /// only using [`OsStr`]s instead.
/// [`Arg::default_values`]: ./struct.Arg.html#method.default_values /// [`Arg::default_values`]: ./struct.Arg.html#method.default_values
/// [`OsStr`]: https://doc.rust-lang.org/std/ffi/struct.OsStr.html /// [`OsStr`]: https://doc.rust-lang.org/std/ffi/struct.OsStr.html
#[inline]
pub fn default_values_os(mut self, vals: &[&'help OsStr]) -> Self { pub fn default_values_os(mut self, vals: &[&'help OsStr]) -> Self {
self.setb(ArgSettings::TakesValue); self.setb(ArgSettings::TakesValue);
self.default_vals = Some(vals.to_vec()); self.default_vals = Some(vals.to_vec());
@ -2699,6 +2723,7 @@ impl<'help> Arg<'help> {
/// ///
/// assert_eq!(m.values_of("flag").unwrap().collect::<Vec<_>>(), vec!["env1", "env2"]); /// assert_eq!(m.values_of("flag").unwrap().collect::<Vec<_>>(), vec!["env1", "env2"]);
/// ``` /// ```
#[inline]
pub fn env(self, name: &'help str) -> Self { pub fn env(self, name: &'help str) -> Self {
self.env_os(OsStr::new(name)) self.env_os(OsStr::new(name))
} }
@ -2706,6 +2731,7 @@ impl<'help> Arg<'help> {
/// Specifies that if the value is not passed in as an argument, that it should be retrieved /// Specifies that if the value is not passed in as an argument, that it should be retrieved
/// from the environment if available in the exact same manner as [`Arg::env`] only using /// from the environment if available in the exact same manner as [`Arg::env`] only using
/// [`OsStr`]s instead. /// [`OsStr`]s instead.
#[inline]
pub fn env_os(mut self, name: &'help OsStr) -> Self { pub fn env_os(mut self, name: &'help OsStr) -> Self {
if !self.is_set(ArgSettings::MultipleOccurrences) { if !self.is_set(ArgSettings::MultipleOccurrences) {
self.setb(ArgSettings::TakesValue); self.setb(ArgSettings::TakesValue);
@ -2770,6 +2796,7 @@ impl<'help> Arg<'help> {
/// ``` /// ```
/// [positional arguments]: ./struct.Arg.html#method.index /// [positional arguments]: ./struct.Arg.html#method.index
/// [index]: ./struct.Arg.html#method.index /// [index]: ./struct.Arg.html#method.index
#[inline]
pub fn display_order(mut self, ord: usize) -> Self { pub fn display_order(mut self, ord: usize) -> Self {
self.disp_ord = ord; self.disp_ord = ord;
self self
@ -2850,6 +2877,7 @@ impl<'help> Arg<'help> {
/// [`AppSettings::SubcommandsNegateReqs`]: ./enum.AppSettings.html#variant.SubcommandsNegateReqs /// [`AppSettings::SubcommandsNegateReqs`]: ./enum.AppSettings.html#variant.SubcommandsNegateReqs
/// [`ArgSettings::Required`]: ./enum.ArgSetings.html#variant.Required /// [`ArgSettings::Required`]: ./enum.ArgSetings.html#variant.Required
/// [`UnknownArgument`]: ./enum.ErrorKind.html#variant.UnknownArgument /// [`UnknownArgument`]: ./enum.ErrorKind.html#variant.UnknownArgument
#[inline]
pub fn last(self, l: bool) -> Self { pub fn last(self, l: bool) -> Self {
if l { if l {
self.setting(ArgSettings::Last) self.setting(ArgSettings::Last)
@ -2909,6 +2937,7 @@ impl<'help> Arg<'help> {
/// assert_eq!(res.unwrap_err().kind, ErrorKind::MissingRequiredArgument); /// assert_eq!(res.unwrap_err().kind, ErrorKind::MissingRequiredArgument);
/// ``` /// ```
/// [`Required`]: ./enum.ArgSettings.html#variant.Required /// [`Required`]: ./enum.ArgSettings.html#variant.Required
#[inline]
pub fn required(self, r: bool) -> Self { pub fn required(self, r: bool) -> Self {
if r { if r {
self.setting(ArgSettings::Required) self.setting(ArgSettings::Required)
@ -2956,6 +2985,7 @@ impl<'help> Arg<'help> {
/// [`Arg::value_delimiter(char)`]: ./struct.Arg.html#method.value_delimiter /// [`Arg::value_delimiter(char)`]: ./struct.Arg.html#method.value_delimiter
/// [`Arg::unset_setting(ArgSettings::UseValueDelimiter)`]: ./enum.ArgSettings.html#variant.UseValueDelimiter /// [`Arg::unset_setting(ArgSettings::UseValueDelimiter)`]: ./enum.ArgSettings.html#variant.UseValueDelimiter
/// [multiple values]: ./enum.ArgSettings.html#variant.MultipleValues /// [multiple values]: ./enum.ArgSettings.html#variant.MultipleValues
#[inline]
pub fn takes_value(self, tv: bool) -> Self { pub fn takes_value(self, tv: bool) -> Self {
if tv { if tv {
self.setting(ArgSettings::TakesValue) self.setting(ArgSettings::TakesValue)
@ -3023,6 +3053,7 @@ impl<'help> Arg<'help> {
/// [`ArgSettings::MultipleValues`]: ./enum.ArgSettings.html#variant.MultipleValues /// [`ArgSettings::MultipleValues`]: ./enum.ArgSettings.html#variant.MultipleValues
/// [`ArgSettings::MultipleOccurrences`]: ./enum.ArgSettings.html#variant.MultipleOccurrences /// [`ArgSettings::MultipleOccurrences`]: ./enum.ArgSettings.html#variant.MultipleOccurrences
/// [`Arg::number_of_values(1)`]: ./struct.Arg.html#method.number_of_values /// [`Arg::number_of_values(1)`]: ./struct.Arg.html#method.number_of_values
#[inline]
pub fn allow_hyphen_values(self, a: bool) -> Self { pub fn allow_hyphen_values(self, a: bool) -> Self {
if a { if a {
self.setting(ArgSettings::AllowHyphenValues) self.setting(ArgSettings::AllowHyphenValues)
@ -3081,6 +3112,7 @@ impl<'help> Arg<'help> {
/// [`RequireEquals`]: ./enum.ArgSettings.html#variant.RequireEquals /// [`RequireEquals`]: ./enum.ArgSettings.html#variant.RequireEquals
/// [`ArgSettings::EmptyValues`]: ./enum.ArgSettings.html#variant.EmptyValues /// [`ArgSettings::EmptyValues`]: ./enum.ArgSettings.html#variant.EmptyValues
/// [`ArgSettings::EmptyValues`]: ./enum.ArgSettings.html#variant.TakesValue /// [`ArgSettings::EmptyValues`]: ./enum.ArgSettings.html#variant.TakesValue
#[inline]
pub fn require_equals(mut self, r: bool) -> Self { pub fn require_equals(mut self, r: bool) -> Self {
if r { if r {
self.unsetb(ArgSettings::AllowEmptyValues); self.unsetb(ArgSettings::AllowEmptyValues);
@ -3133,6 +3165,7 @@ impl<'help> Arg<'help> {
/// [`ArgMatches`]: ./struct.ArgMatches.html /// [`ArgMatches`]: ./struct.ArgMatches.html
/// [`ArgMatches::is_present("flag")`]: ./struct.ArgMatches.html#method.is_present /// [`ArgMatches::is_present("flag")`]: ./struct.ArgMatches.html#method.is_present
/// [`Arg`]: ./struct.Arg.html /// [`Arg`]: ./struct.Arg.html
#[inline]
pub fn global(mut self, g: bool) -> Self { pub fn global(mut self, g: bool) -> Self {
self.global = g; self.global = g;
self self
@ -3207,6 +3240,7 @@ impl<'help> Arg<'help> {
/// ``` /// ```
/// [`ArgSettings::UseValueDelimiter`]: ./enum.ArgSettings.html#variant.UseValueDelimiter /// [`ArgSettings::UseValueDelimiter`]: ./enum.ArgSettings.html#variant.UseValueDelimiter
/// [`ArgSettings::TakesValue`]: ./enum.ArgSettings.html#variant.TakesValue /// [`ArgSettings::TakesValue`]: ./enum.ArgSettings.html#variant.TakesValue
#[inline]
pub fn require_delimiter(mut self, d: bool) -> Self { pub fn require_delimiter(mut self, d: bool) -> Self {
if d { if d {
self.setb(ArgSettings::UseValueDelimiter); self.setb(ArgSettings::UseValueDelimiter);
@ -3247,6 +3281,7 @@ impl<'help> Arg<'help> {
/// ``` /// ```
/// If we were to run the above program with `--help` the `[values: fast, slow]` portion of /// If we were to run the above program with `--help` the `[values: fast, slow]` portion of
/// the help text would be omitted. /// the help text would be omitted.
#[inline]
pub fn hide_possible_values(self, hide: bool) -> Self { pub fn hide_possible_values(self, hide: bool) -> Self {
if hide { if hide {
self.setting(ArgSettings::HidePossibleValues) self.setting(ArgSettings::HidePossibleValues)
@ -3282,6 +3317,7 @@ impl<'help> Arg<'help> {
/// ///
/// If we were to run the above program with `--help` the `[default: localhost]` portion of /// If we were to run the above program with `--help` the `[default: localhost]` portion of
/// the help text would be omitted. /// the help text would be omitted.
#[inline]
pub fn hide_default_value(self, hide: bool) -> Self { pub fn hide_default_value(self, hide: bool) -> Self {
if hide { if hide {
self.setting(ArgSettings::HideDefaultValue) self.setting(ArgSettings::HideDefaultValue)
@ -3328,6 +3364,7 @@ impl<'help> Arg<'help> {
/// -h, --help Prints help information /// -h, --help Prints help information
/// -V, --version Prints version information /// -V, --version Prints version information
/// ``` /// ```
#[inline]
pub fn hidden(self, h: bool) -> Self { pub fn hidden(self, h: bool) -> Self {
if h { if h {
self.setting(ArgSettings::Hidden) self.setting(ArgSettings::Hidden)
@ -3378,6 +3415,7 @@ impl<'help> Arg<'help> {
/// assert_eq!(&*matched_vals, &["TeSt123", "teST123", "tESt321"]); /// assert_eq!(&*matched_vals, &["TeSt123", "teST123", "tESt321"]);
/// ``` /// ```
/// [`arg_enum!`]: ./macro.arg_enum.html /// [`arg_enum!`]: ./macro.arg_enum.html
#[inline]
pub fn case_insensitive(self, ci: bool) -> Self { pub fn case_insensitive(self, ci: bool) -> Self {
if ci { if ci {
self.setting(ArgSettings::IgnoreCase) self.setting(ArgSettings::IgnoreCase)
@ -3433,6 +3471,7 @@ impl<'help> Arg<'help> {
/// assert_eq!(nodelims.value_of("option").unwrap(), "val1,val2,val3"); /// assert_eq!(nodelims.value_of("option").unwrap(), "val1,val2,val3");
/// ``` /// ```
/// [`Arg::value_delimiter`]: ./struct.Arg.html#method.value_delimiter /// [`Arg::value_delimiter`]: ./struct.Arg.html#method.value_delimiter
#[inline]
pub fn use_delimiter(mut self, d: bool) -> Self { pub fn use_delimiter(mut self, d: bool) -> Self {
if d { if d {
if self.val_delim.is_none() { if self.val_delim.is_none() {
@ -3476,6 +3515,7 @@ impl<'help> Arg<'help> {
/// ///
/// If we were to run the above program with `$ CONNECT=super_secret connect --help` the /// If we were to run the above program with `$ CONNECT=super_secret connect --help` the
/// `[default: CONNECT=super_secret]` portion of the help text would be omitted. /// `[default: CONNECT=super_secret]` portion of the help text would be omitted.
#[inline]
pub fn hide_env_values(self, hide: bool) -> Self { pub fn hide_env_values(self, hide: bool) -> Self {
if hide { if hide {
self.setting(ArgSettings::HideEnvValues) self.setting(ArgSettings::HideEnvValues)
@ -3528,6 +3568,7 @@ impl<'help> Arg<'help> {
/// on a line after the option /// on a line after the option
/// ``` /// ```
/// [`AppSettings::NextLineHelp`]: ./enum.AppSettings.html#variant.NextLineHelp /// [`AppSettings::NextLineHelp`]: ./enum.AppSettings.html#variant.NextLineHelp
#[inline]
pub fn next_line_help(mut self, nlh: bool) -> Self { pub fn next_line_help(mut self, nlh: bool) -> Self {
if nlh { if nlh {
self.setb(ArgSettings::NextLineHelp); self.setb(ArgSettings::NextLineHelp);
@ -3716,6 +3757,7 @@ impl<'help> Arg<'help> {
/// [specific number of values]: ./struct.Arg.html#method.number_of_values /// [specific number of values]: ./struct.Arg.html#method.number_of_values
/// [maximum]: ./struct.Arg.html#method.max_values /// [maximum]: ./struct.Arg.html#method.max_values
/// [specific]: ./struct.Arg.html#method.number_of_values /// [specific]: ./struct.Arg.html#method.number_of_values
#[inline]
pub fn multiple(mut self, multi: bool) -> Self { pub fn multiple(mut self, multi: bool) -> Self {
if multi { if multi {
self.setb(ArgSettings::MultipleOccurrences); self.setb(ArgSettings::MultipleOccurrences);
@ -3775,6 +3817,7 @@ impl<'help> Arg<'help> {
/// assert_eq!(res.unwrap().value_of("config"), None); /// assert_eq!(res.unwrap().value_of("config"), None);
/// ``` /// ```
/// [`ArgSettings::TakesValue`]: ./enum.ArgSettings.html#variant.TakesValue /// [`ArgSettings::TakesValue`]: ./enum.ArgSettings.html#variant.TakesValue
#[inline]
pub fn multiple_values(self, multi: bool) -> Self { pub fn multiple_values(self, multi: bool) -> Self {
if multi { if multi {
self.setting(ArgSettings::MultipleValues) self.setting(ArgSettings::MultipleValues)
@ -3844,6 +3887,7 @@ impl<'help> Arg<'help> {
/// [specific number of values]: ./struct.Arg.html#method.number_of_values /// [specific number of values]: ./struct.Arg.html#method.number_of_values
/// [maximum]: ./struct.Arg.html#method.max_values /// [maximum]: ./struct.Arg.html#method.max_values
/// [specific]: ./struct.Arg.html#method.number_of_values /// [specific]: ./struct.Arg.html#method.number_of_values
#[inline]
pub fn multiple_occurrences(self, multi: bool) -> Self { pub fn multiple_occurrences(self, multi: bool) -> Self {
if multi { if multi {
self.setting(ArgSettings::MultipleOccurrences) self.setting(ArgSettings::MultipleOccurrences)
@ -3871,6 +3915,7 @@ impl<'help> Arg<'help> {
/// [`Arg::allow_hyphen_values(true)`]: ./struct.Arg.html#method.allow_hyphen_values /// [`Arg::allow_hyphen_values(true)`]: ./struct.Arg.html#method.allow_hyphen_values
/// [`Arg::last(true)`]: ./struct.Arg.html#method.last /// [`Arg::last(true)`]: ./struct.Arg.html#method.last
/// [`AppSettings::TrailingVarArg`]: ./enum.AppSettings.html#variant.TrailingVarArg /// [`AppSettings::TrailingVarArg`]: ./enum.AppSettings.html#variant.TrailingVarArg
#[inline]
pub fn raw(self, raw: bool) -> Self { pub fn raw(self, raw: bool) -> Self {
self.multiple(raw).allow_hyphen_values(raw).last(raw) self.multiple(raw).allow_hyphen_values(raw).last(raw)
} }
@ -3944,6 +3989,7 @@ impl<'help> Arg<'help> {
/// -h, --help Prints help information /// -h, --help Prints help information
/// -V, --version Prints version information /// -V, --version Prints version information
/// ``` /// ```
#[inline]
pub fn hidden_short_help(self, hide: bool) -> Self { pub fn hidden_short_help(self, hide: bool) -> Self {
if hide { if hide {
self.setting(ArgSettings::HiddenShortHelp) self.setting(ArgSettings::HiddenShortHelp)
@ -4021,6 +4067,7 @@ impl<'help> Arg<'help> {
/// -h, --help Prints help information /// -h, --help Prints help information
/// -V, --version Prints version information /// -V, --version Prints version information
/// ``` /// ```
#[inline]
pub fn hidden_long_help(self, hide: bool) -> Self { pub fn hidden_long_help(self, hide: bool) -> Self {
if hide { if hide {
self.setting(ArgSettings::HiddenLongHelp) self.setting(ArgSettings::HiddenLongHelp)
@ -4032,12 +4079,14 @@ impl<'help> Arg<'help> {
// @TODO @docs @v3-beta: write better docs as ArgSettings is now critical // @TODO @docs @v3-beta: write better docs as ArgSettings is now critical
/// Checks if one of the [`ArgSettings`] is set for the argument /// Checks if one of the [`ArgSettings`] is set for the argument
/// [`ArgSettings`]: ./enum.ArgSettings.html /// [`ArgSettings`]: ./enum.ArgSettings.html
#[inline]
pub fn is_set(&self, s: ArgSettings) -> bool { pub fn is_set(&self, s: ArgSettings) -> bool {
self.settings.is_set(s) self.settings.is_set(s)
} }
/// Sets one of the [`ArgSettings`] settings for the argument /// Sets one of the [`ArgSettings`] settings for the argument
/// [`ArgSettings`]: ./enum.ArgSettings.html /// [`ArgSettings`]: ./enum.ArgSettings.html
#[inline]
pub fn setting(mut self, s: ArgSettings) -> Self { pub fn setting(mut self, s: ArgSettings) -> Self {
self.setb(s); self.setb(s);
self self
@ -4055,12 +4104,14 @@ impl<'help> Arg<'help> {
/// Unsets one of the [`ArgSettings`] for the argument /// Unsets one of the [`ArgSettings`] for the argument
/// [`ArgSettings`]: ./enum.ArgSettings.html /// [`ArgSettings`]: ./enum.ArgSettings.html
#[inline]
pub fn unset_setting(mut self, s: ArgSettings) -> Self { pub fn unset_setting(mut self, s: ArgSettings) -> Self {
self.unsetb(s); self.unsetb(s);
self self
} }
/// Set a custom heading for this arg to be printed under /// Set a custom heading for this arg to be printed under
#[inline]
pub fn help_heading(mut self, s: Option<&'help str>) -> Self { pub fn help_heading(mut self, s: Option<&'help str>) -> Self {
self.help_heading = s; self.help_heading = s;
self self

3
src/build/arg_group.rs
View file

@ -125,6 +125,7 @@ impl<'a> ArgGroup<'a> {
/// let ag = ArgGroup::from_yaml(yml); /// let ag = ArgGroup::from_yaml(yml);
/// ``` /// ```
#[cfg(feature = "yaml")] #[cfg(feature = "yaml")]
#[inline]
pub fn from_yaml(y: &'a yaml_rust::Yaml) -> ArgGroup<'a> { pub fn from_yaml(y: &'a yaml_rust::Yaml) -> ArgGroup<'a> {
ArgGroup::from(y.as_hash().unwrap()) ArgGroup::from(y.as_hash().unwrap())
} }
@ -222,6 +223,7 @@ impl<'a> ArgGroup<'a> {
/// assert_eq!(err.kind, ErrorKind::ArgumentConflict); /// assert_eq!(err.kind, ErrorKind::ArgumentConflict);
/// ``` /// ```
/// ['Arg']: ./struct.Arg.html /// ['Arg']: ./struct.Arg.html
#[inline]
pub fn multiple(mut self, m: bool) -> Self { pub fn multiple(mut self, m: bool) -> Self {
self.multiple = m; self.multiple = m;
self self
@ -261,6 +263,7 @@ impl<'a> ArgGroup<'a> {
/// [`App`]: ./struct.App.html /// [`App`]: ./struct.App.html
/// [``]: ./struct..html /// [``]: ./struct..html
/// [`ArgGroup::multiple`]: ./struct.ArgGroup.html#method.multiple /// [`ArgGroup::multiple`]: ./struct.ArgGroup.html#method.multiple
#[inline]
pub fn required(mut self, r: bool) -> Self { pub fn required(mut self, r: bool) -> Self {
self.required = r; self.required = r;
self self

1
src/parse/errors.rs
View file

@ -418,6 +418,7 @@ impl Error {
} }
/// Should the message be written to `stdout` or not /// Should the message be written to `stdout` or not
#[inline]
pub fn use_stderr(&self) -> bool { pub fn use_stderr(&self) -> bool {
match self.kind { match self.kind {
ErrorKind::HelpDisplayed | ErrorKind::VersionDisplayed => false, ErrorKind::HelpDisplayed | ErrorKind::VersionDisplayed => false,

2
src/parse/matches/arg_matches.rs
View file

@ -856,6 +856,7 @@ impl ArgMatches {
/// [`Subcommand`]: ./struct..html /// [`Subcommand`]: ./struct..html
/// [`App`]: ./struct.App.html /// [`App`]: ./struct.App.html
/// [`ArgMatches`]: ./struct.ArgMatches.html /// [`ArgMatches`]: ./struct.ArgMatches.html
#[inline]
pub fn subcommand_name(&self) -> Option<&str> { pub fn subcommand_name(&self) -> Option<&str> {
self.subcommand.as_ref().map(|sc| &*sc.name) self.subcommand.as_ref().map(|sc| &*sc.name)
} }
@ -907,6 +908,7 @@ impl ArgMatches {
/// ``` /// ```
/// [`ArgMatches::subcommand_matches`]: ./struct.ArgMatches.html#method.subcommand_matches /// [`ArgMatches::subcommand_matches`]: ./struct.ArgMatches.html#method.subcommand_matches
/// [`ArgMatches::subcommand_name`]: ./struct.ArgMatches.html#method.subcommand_name /// [`ArgMatches::subcommand_name`]: ./struct.ArgMatches.html#method.subcommand_name
#[inline]
pub fn subcommand(&self) -> (&str, Option<&ArgMatches>) { pub fn subcommand(&self) -> (&str, Option<&ArgMatches>) {
self.subcommand self.subcommand
.as_ref() .as_ref()