Struct Indices

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

Iterate over indices for where an argument appeared when parsing, via ArgMatches::indices_of

Examples

# use clap_builder as clap;
# use clap::{Command, Arg, ArgAction};
let m = Command::new("myapp")
    .arg(Arg::new("output")
        .short('o')
        .num_args(1..)
        .action(ArgAction::Set))
    .get_matches_from(vec!["myapp", "-o", "val1", "val2"]);

let mut indices = m.indices_of("output").unwrap();

assert_eq!(indices.next(), Some(2));
assert_eq!(indices.next(), Some(3));
assert_eq!(indices.next(), None);

Trait Implementations

impl Default for Indices<'_>

fn default() -> Self

impl DoubleEndedIterator for Indices<'_>

fn next_back(&mut self) -> Option<usize>

impl ExactSizeIterator for Indices<'_>

impl Iterator for Indices<'_>

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

impl<'a> Clone for Indices<'a>

fn clone(&self) -> Indices<'a>

impl<'a> Debug for Indices<'a>

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

Auto Trait Implementations

impl<'a> Freeze for Indices<'a>

impl<'a> RefUnwindSafe for Indices<'a>

impl<'a> Send for Indices<'a>

impl<'a> Sync for Indices<'a>

impl<'a> Unpin for Indices<'a>

impl<'a> UnsafeUnpin for Indices<'a>

impl<'a> UnwindSafe for Indices<'a>

Blanket Implementations

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

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

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

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

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

impl<T> From<T> for Indices<'a>

fn from(t: T) -> T

Returns the argument unchanged.

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

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

impl<T, U> Into<U> for Indices<'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<U> for Indices<'a> where U: Into<T>,

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

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

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