Struct ap::Arg [−][src]
pub struct Arg { pub option: char, pub needs: Need, pub help: Option<String>, pub required: bool, pub value: Option<String>, pub count: usize, }
An argument, either an option or a positional argument.
-
It is used to specify how an argument is to be handled.
If it is to be considered an option, the [Arg.option] member should be set.
-
To store the results of the parse for the argument.
For example, the parser records the number of times the argument was handled in the
count
member.
Note
- All members are public for handler convenience.
Fields
option: char
Single character short option name (required). Can be set to special values for non-standard behaviour:
- POSITIONAL_HANDLER_OPT (to handle positional arguments).
- UNKNOWN_OPTION_HANDLER_OPT (to handle unknown options).
needs: Need
Type of option (required, but defaults).
help: Option<String>
Description of the option.
required: bool
Set if the option must be specified.
value: Option<String>
Value specified for this option
(if the needs
member is not Need::Nothing).
Notes
- This is equivalent to
getopt(3)
’soptarg
value. - This will be None for flag options.
count: usize
Number of times the option was specified.
Notes
- Used internally for Error::MissingReqOpt.
- If a positional argument handler has been registered, value will be incremented for each positional argument specified.
- This is similar to
getopt(3)
’soptind
value, but rather than being the overall index, it is a value incremented each time the particular option is specified on the command-line.
Implementations
impl Arg
[src]
pub fn new(option: char) -> Self
[src]
Create a new argument handler.
pub fn option(self, option: char) -> Self
[src]
Specify the option character (name) for the option.
pub fn needs(self, needs: Need) -> Self
[src]
Specify the requirement for the option.
pub fn help(self, help: &str) -> Self
[src]
Specify the help text for the option.
pub fn required(self) -> Self
[src]
Specify that the option must be provided on the command-line.
Trait Implementations
impl Clone for Arg
[src]
impl Debug for Arg
[src]
impl Default for Arg
[src]
impl Display for Arg
[src]
impl Eq for Arg
[src]
impl Ord for Arg
[src]
fn cmp(&self, other: &Arg) -> Ordering
[src]
#[must_use]pub fn max(self, other: Self) -> Self
1.21.0[src]
#[must_use]pub fn min(self, other: Self) -> Self
1.21.0[src]
#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self
1.50.0[src]
impl PartialEq<Arg> for Arg
[src]
impl PartialOrd<Arg> for Arg
[src]
fn partial_cmp(&self, other: &Arg) -> Option<Ordering>
[src]
#[must_use]pub fn lt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn le(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn gt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn ge(&self, other: &Rhs) -> bool
1.0.0[src]
impl StructuralEq for Arg
[src]
impl StructuralPartialEq for Arg
[src]
Auto Trait Implementations
impl RefUnwindSafe for Arg
impl Send for Arg
impl Sync for Arg
impl Unpin for Arg
impl UnwindSafe for Arg
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T> ToString for T where
T: Display + ?Sized,
[src]
T: Display + ?Sized,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,