Enum aopt::opt::Index

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

Index using for option match.

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

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

Variants

Forward(usize)

The forward index of NOA.

Example

For ["--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.

Example

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

@-1 will matching "pos3".

@-2 will matching "pos2".

@-3 will matching "pos1".

List(Vec<usize>)

The include list of forward index of NOA.

Example

For ["--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.

Example

For ["--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, usize)

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

Example

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

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

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

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

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

@..2 will matching "pos1".

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

AnyWhere

The anywhere position of NOA.

Example

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

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

Null

Implementations

impl Index

pub fn parse(pattern: &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() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Index

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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 PartialEq<Index> 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 Serialize for Index

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToString for Index

fn to_string(&self) -> String

Converts the given value to a String.

impl Eq for Index

impl StructuralEq for Index

impl StructuralPartialEq for Index