Enum aopt::opt::Index

pub enum Index {
    Forward(usize),
    Backward(usize),
    List(Vec<usize>),
    Except(Vec<usize>),
    Range(usize, Option<usize>),
    AnyWhere,
    Null,
}

Index using for option match.

The index is the position of left arguments (non-option arguments, NOA) index.

Example

foo.exe -a=value -b value pos1 --aopt=42 pos2 --bopt value pos3
            |     |   |    |      |       |      |     |     |
            |     |   |    |      |       |      |     |     NOA @3 or @-1
            |     |   |    |      |       |      |     value of --bopt
            |     |   |    |      |       |      option --bopt
            |     |   |    |      |       NOA @2 or @-2
            |     |   |    |    option --aopt and its value 42
            |     |   |   NOA @1
            |     |   value of -b
            |    option -b
        option -a and its value

For option check, see SetChecker for more information.

Variants

Forward(usize)

The forward index of NOA, fixed position.

Example

For ["app", "--aopt", "--bopt=42", "pos1", "--copt", "pos2", "--dopt", "value", "pos3"]:

@1 will matching "pos1".

@2 will matching "pos2".

@3 will matching "pos3".

Backward(usize)

The backward index of NOA, floating position.

Example

For ["app", "--aopt", "--bopt=42", "pos1", "--copt", "pos2", "--dopt", "value", "pos3"]:

@-1 will matching "pos2".

@-2 will matching "pos1".

@-3 will matching "app".

List(Vec<usize>)

The include list of forward index of NOA, fixed position.

Example

For ["app", "--aopt", "--bopt=42", "pos1", "--copt", "pos2", "--dopt", "value", "pos3"]:

@[1,3] will matching "pos1" or "pos3".

@[1,2] will matching "pos1" or "pos2".

@[1,2,3] will matching "pos1", "pos2" or "pos3".

Except(Vec<usize>)

The exclude list of forward index of NOA, floating position.

Example

For ["app", "--aopt", "--bopt=42", "pos1", "--copt", "pos2", "--dopt", "value", "pos3"]:

@-[1,3] will matching "pos2".

@-[3] will matching "pos1" or "pos2".

@-[2] will matching "pos1" or "pos3".

Range(usize, Option<usize>)

The NOA which index inside in given position range with format (m..n].

If range have upper limit, the index is fixed position otherwise it is floating position.

Example

For ["app", "--aopt", "--bopt=42", "pos1", "--copt", "pos2", "--dopt", "value", "pos3"]:

@0.. will matching "app", "pos1", "pos2" or "pos3".

@2.. will matching "pos2", "pos3".

@1.. will matching "pos1", "pos2" or "pos3".

@..4 will matching "app", "pos1", "pos2" or "pos3".

@..2 will matching "app", "pos1".

@1..3 will matching "pos1", "pos2".

AnyWhere

The anywhere position of NOA, floating position.

Example

For ["app", "--aopt", "--bopt=42", "pos1", "--copt", "pos2", "--dopt", "value", "pos3"]:

@* will matching "app", "pos1", "pos2" or "pos3".

Null

Implementations

impl Index

pub fn parse_ctx(storer: &mut SpanStorer, str: &str) -> Result<(), Error>

pub fn parse(pat: &str) -> Result<Self, Error>

pub fn is_null(&self) -> bool

pub fn is_forward(&self) -> bool

pub fn is_backward(&self) -> bool

pub fn is_list(&self) -> bool

pub fn is_except(&self) -> bool

pub fn is_range(&self) -> bool

pub fn is_anywhere(&self) -> bool

pub fn to_help(&self) -> String

pub fn forward(index: usize) -> Self

pub fn backward(index: usize) -> Self

pub fn list(list: Vec<usize>) -> Self

pub fn except(list: Vec<usize>) -> Self

pub fn range(start: Option<usize>, end: Option<usize>) -> Self

pub fn anywhere() -> Self

pub fn null() -> Self

pub fn calc_index(&self, noa_index: usize, noa_count: usize) -> Option<usize>

Trait Implementations

impl Clone for Index

fn clone(&self) -> Index

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Index

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

Formats the value using the given formatter.

impl Default for Index

fn default() -> Index

Returns the “default value” for a type.

impl Display for Index

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

Formats the value using the given formatter.

impl Hash for Index

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Index

fn cmp(&self, other: &Index) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Index

fn eq(&self, other: &Index) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Index

fn partial_cmp(&self, other: &Index) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a> TryFrom<&'a Range<usize>> for Index

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &'a Range<usize>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a RangeFrom<usize>> for Index

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &'a RangeFrom<usize>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a RangeFull> for Index

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &'a RangeFull) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a RangeInclusive<usize>> for Index

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &'a RangeInclusive<usize>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a RangeTo<usize>> for Index

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &'a RangeTo<usize>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a RangeToInclusive<usize>> for Index

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &'a RangeToInclusive<usize>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a str> for Index

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &'a str) -> Result<Self, Self::Error>

Performs the conversion.

impl<const N: usize> TryFrom<[usize; N]> for Index

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: [usize; N]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<AStr> for Index

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: AStr) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Range<usize>> for Index

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Range<usize>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<RangeFrom<usize>> for Index

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: RangeFrom<usize>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<RangeFull> for Index

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: RangeFull) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<RangeInclusive<usize>> for Index

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: RangeInclusive<usize>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<RangeTo<usize>> for Index

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: RangeTo<usize>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<RangeToInclusive<usize>> for Index

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: RangeToInclusive<usize>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<String> for Index

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Vec<usize>> for Index

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Vec<usize>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<i128> for Index

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: i128) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<i16> for Index

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: i16) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<i32> for Index

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: i32) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<i64> for Index

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: i64) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<i8> for Index

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: i8) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<isize> for Index

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: isize) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<u128> for Index

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: u128) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<u16> for Index

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: u16) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<u32> for Index

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: u32) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<u64> for Index

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: u64) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<u8> for Index

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: u8) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<usize> for Index

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: usize) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Index

impl StructuralPartialEq for Index