Struct getopt::State

pub struct State {
    pub index: usize,
    pub point: usize,
}

The current state of the parser.

args[index] is the current element being parsed. args[index][point] is the current character being parsed.

After parsing is complete (that is, Opt(None, None) is returned), any remaining arguments can be found in args beginning at index.

Example

use getopt::prelude::*;

// args = ["program", "-abc", "foo"];
let optstring = "ab:c";
let mut state = State::new();

getopt(&args, optstring, &mut state)?;
assert_eq!(State { index: 1, point: 2 }, state);
getopt(&args, optstring, &mut state)?;
assert_eq!(State { index: 2, point: 0 }, state);
getopt(&args, optstring, &mut state)?;
assert_eq!(State { index: 2, point: 0 }, state);
assert_eq!("foo", args[state.index]);

Fields

index: usize

point: usize

Implementations

impl State

pub fn new() -> State

Constructs a new State, with index and point initialized to 1 and 0, respectively.

Trait Implementations

impl Debug for State

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

Formats the value using the given formatter.

impl Default for State

fn default() -> State

Returns the “default value” for a type.

impl Ord for State

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<State> for State

fn eq(&self, other: &State) -> 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<State> for State

fn partial_cmp(&self, other: &State) -> 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 Eq for State

impl StructuralEq for State

impl StructuralPartialEq for State