Struct `IdsRef`

pub struct IdsRef<'a> { /* private fields */ }

Iterate over [Arg][crate::Arg] and [ArgGroup][crate::ArgGroup] Ids via ArgMatches::ids.

Examples

# use clap_builder as clap;
# use clap::{Command, arg, value_parser};

let m = Command::new("myprog")
    .arg(arg!(--color <when>)
        .value_parser(["auto", "always", "never"]))
    .arg(arg!(--config <path>)
        .value_parser(value_parser!(std::path::PathBuf)))
    .get_matches_from(["myprog", "--config=config.toml", "--color=auto"]);
assert_eq!(
    m.ids()
        .map(|id| id.as_str())
        .collect::<Vec<_>>(),
    ["config", "color"]
);

Trait Implementations

`impl ExactSizeIterator for IdsRef<'_>`

`impl<'a> Clone for IdsRef<'a>`

fn clone(&self) -> Self

`impl<'a> Debug for IdsRef<'a>`

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

`impl<'a> DoubleEndedIterator for IdsRef<'a>`

fn next_back(&mut self) -> Option<&'a Id>

`impl<'a> Iterator for IdsRef<'a>`

type Item = &'a Id;
fn next(&mut self) -> Option<&'a Id>
fn size_hint(&self) -> (usize, Option<usize>)

Auto Trait Implementations

`impl<'a> Freeze for IdsRef<'a>`

`impl<'a> RefUnwindSafe for IdsRef<'a>`

`impl<'a> Send for IdsRef<'a>`

`impl<'a> Sync for IdsRef<'a>`

`impl<'a> Unpin for IdsRef<'a>`

`impl<'a> UnsafeUnpin for IdsRef<'a>`

`impl<'a> UnwindSafe for IdsRef<'a>`

Blanket Implementations

`impl IntoIterator for IdsRef<'a> where I: Iterator,`

type Item = ::Item;
type IntoIter = I;
fn into_iter(self) -> I

`impl<T> Any for IdsRef<'a> where T: 'static + ?Sized,`

fn type_id(&self) -> TypeId

`impl<T> Borrow<T> for IdsRef<'a> where T: ?Sized,`

fn borrow(&self) -> &T

`impl<T> BorrowMut<T> for IdsRef<'a> where T: ?Sized,`

fn borrow_mut(&mut self) -> &mut T

`impl<T> CloneToUninit for IdsRef<'a> where T: Clone,`

unsafe fn clone_to_uninit(&self, dest: *mut u8)

`impl<T> From<T> for IdsRef<'a>`

fn from(t: T) -> T: Returns the argument unchanged.

`impl<T> ToOwned for IdsRef<'a> where T: Clone,`

type Owned = T;
fn to_owned(&self) -> T
fn clone_into(&self, target: &mut T)

`impl<T, U> Into for IdsRef<'a> where U: From<T>,`

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of [From]<T> for U chooses to do.

`impl<T, U> TryFrom for IdsRef<'a> where U: Into<T>,`

type Error = never;
fn try_from(value: U) -> Result<T, never>

`impl<T, U> TryInto for IdsRef<'a> where U: TryFrom<T>,`

type Error = >::Error;
fn try_into(self) -> Result<U, >::Error>