Struct IdsRef

struct IdsRef<'a> { ... }

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"]
);

Implementations

impl ExactSizeIterator for IdsRef<'_>

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

fn clone(self: &Self) -> IdsRef<'a>

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

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

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

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

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

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

fn next(self: &mut Self) -> Option<&'a Id>
fn size_hint(self: &Self) -> (usize, Option<usize>)

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>

impl<I> IntoIterator for IdsRef<'a>

fn into_iter(self: Self) -> I

impl<T> Any for IdsRef<'a>

fn type_id(self: &Self) -> TypeId

impl<T> Borrow for IdsRef<'a>

fn borrow(self: &Self) -> &T

impl<T> BorrowMut for IdsRef<'a>

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

impl<T> CloneToUninit for IdsRef<'a>

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

impl<T> From for IdsRef<'a>

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> ToOwned for IdsRef<'a>

fn to_owned(self: &Self) -> T
fn clone_into(self: &Self, target: &mut T)

impl<T, U> Into for IdsRef<'a>

fn into(self: 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>

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto for IdsRef<'a>

fn try_into(self: Self) -> Result<U, <U as TryFrom<T>>::Error>