Struct Argv 

pub struct Argv<'i> { /* private fields */ }

A command line being parsed: the Stream every parser in this crate reads.

Its checkpoint is the whole state, so alt backtracking restores the Mode and the position inside a bundle along with the word.

Implementations

impl<'i> Argv<'i>

pub fn new(words: &'i [&'i BStr]) -> Self

Parse words, which should not include the program name.

pub fn is_empty(&self) -> bool

Whether every word has been consumed.

pub fn words_left(&self) -> usize

How many words are left, the current one included.

pub fn mode(&self) -> Mode

Where in the grammar the stream is.

pub fn stop_flags(&mut self)

Read every remaining word as a value, as if -- had been typed. An argument declared double_dash = "automatic" or stop_flags does this once it has a value.

pub fn resume_flags(&mut self)

Recognize flags again after -- or Argv::stop_flags: a command’s restart_token starts a fresh invocation.

pub fn offset(&self) -> usize

Byte offset from the start of the command line, one separator counted per word.

pub fn front(&self) -> &'i [u8]

The unread part of the current word; empty at the end.

Trait Implementations

impl<'i> Clone for Argv<'i>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'i> Copy for Argv<'i>

impl Debug for Argv<'_>

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

Formats the value using the given formatter.

impl<'i> Eq for Argv<'i>

impl<'i, E> FromExternalError<Argv<'i>, E> for Error

where E: Error + Send + Sync + 'static,

Lets try_map report a conversion failure. It backtracks, like any winnow error; the flag parsers in crate::combinator convert values themselves and commit, so their errors can name the flag.

fn from_external_error(input: &Argv<'i>, e: E) -> Self

Like ParserError::from_input but also include an external error.

impl Location for Argv<'_>

fn previous_token_end(&self) -> usize

Previous token’s end offset

fn current_token_start(&self) -> usize

Current token’s start offset

impl Offset for Argv<'_>

fn offset_from(&self, start: &Self) -> usize

Offset between the first byte of start and the first byte of selfa

impl<'i, const N: usize> Parser<Argv<'i>, Arg<'i>, Error> for Named<N>

One occurrence of the flag’s name, value not yet read.

fn parse_next(&mut self, input: &mut Argv<'i>) -> Result<Arg<'i>, Error>

Take tokens from the Stream, turning it into the output

fn parse( &mut self, input: I, ) -> Result<O, ParseError<I, <E as ParserError<I>>::Inner>>

where Self: Sized, I: Stream + StreamIsPartial, E: ParserError<I>, <E as ParserError<I>>::Inner: ParserError<I>,

Parse all of input, generating O from it

fn parse_iter(&mut self, input: I) -> ParseIter<'_, Self, I, O, E>

where Self: Sized, I: Stream + StreamIsPartial, E: ParserError<I>, <E as ParserError<I>>::Inner: ParserError<I>,

Repeat this parse until all of input is consumed, generating O from it

fn parse_peek(&mut self, input: I) -> Result<(I, O), E>

Take tokens from the Stream, turning it into the output

fn by_ref(&mut self) -> ByRef<'_, Self, I, O, E>

where Self: Sized,

Treat &mut Self as a parser

fn value<O2>(self, val: O2) -> Value<Self, I, O, O2, E>

where Self: Sized, O2: Clone,

Produce the provided value

fn default_value<O2>(self) -> DefaultValue<Self, I, O, O2, E>

where Self: Sized, O2: Default,

Produce a type’s default value

fn void(self) -> Void<Self, I, O, E>

where Self: Sized,

Discards the output of the Parser

fn output_into<O2>(self) -> OutputInto<Self, I, O, O2, E>

where Self: Sized, O: Into<O2>,

Convert the parser’s output to another type using std::convert::From

fn take(self) -> Take<Self, I, O, E>

where Self: Sized, I: Stream,

Produce the consumed input as produced value.

fn with_taken(self) -> WithTaken<Self, I, O, E>

where Self: Sized, I: Stream,

Produce the consumed input with the output

fn span(self) -> Span<Self, I, O, E>

where Self: Sized, I: Stream + Location,

Produce the location of the consumed input as produced value.

fn with_span(self) -> WithSpan<Self, I, O, E>

where Self: Sized, I: Stream + Location,

Produce the location of consumed input with the output

fn map<G, O2>(self, map: G) -> Map<Self, G, I, O, O2, E>

where G: FnMut(O) -> O2, Self: Sized,

Maps a function over the output of a parser

fn try_map<G, O2, E2>(self, map: G) -> TryMap<Self, G, I, O, O2, E, E2>

where Self: Sized, G: FnMut(O) -> Result<O2, E2>, I: Stream, E: FromExternalError<I, E2> + ParserError<I>,

Applies a function returning a Result over the output of a parser.

fn verify_map<G, O2>(self, map: G) -> VerifyMap<Self, G, I, O, O2, E>

where Self: Sized, G: FnMut(O) -> Option<O2>, I: Stream, E: ParserError<I>,

Apply both Parser::verify and Parser::map.

fn flat_map<G, H, O2>(self, map: G) -> FlatMap<Self, G, H, I, O, O2, E>

where Self: Sized, G: FnMut(O) -> H, H: Parser<I, O2, E>,

Creates a parser from the output of this one

fn parse_to<O2>(self) -> ParseTo<Self, I, O, O2, E>

where Self: Sized, I: Stream, O: ParseSlice<O2>, E: ParserError<I>,

Apply std::str::FromStr to the output of the parser

fn verify<G, O2>(self, filter: G) -> Verify<Self, G, I, O, O2, E>

where Self: Sized, G: FnMut(&O2) -> bool, I: Stream, O: Borrow<O2>, E: ParserError<I>, O2: ?Sized,

Returns the output of the child parser if it satisfies a verification function.

fn context<C>(self, context: C) -> Context<Self, I, O, E, C>

where Self: Sized, I: Stream, E: AddContext<I, C> + ParserError<I>, C: Clone + Debug,

If parsing fails, add context to the error

fn context_with<F, C, FI>( self, context: F, ) -> ContextWith<Self, I, O, E, F, C, FI>

where Self: Sized, I: Stream, E: AddContext<I, C> + ParserError<I>, F: Fn() -> FI + Clone, C: Debug, FI: Iterator<Item = C>,

If parsing fails, dynamically add context to the error

fn map_err<G, E2>(self, map: G) -> MapErr<Self, G, I, O, E, E2>

where G: FnMut(E) -> E2, Self: Sized,

Maps a function over the error of a parser

fn complete_err(self) -> CompleteErr<Self, I, O, E>

where Self: Sized,

Transforms Incomplete into Backtrack

fn err_into<E2>(self) -> ErrInto<Self, I, O, E, E2>

where Self: Sized, E: Into<E2>,

Convert the parser’s error to another type using std::convert::From

impl<'i> ParserError<Argv<'i>> for Error

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

Keep whichever of the two says more: a specific failure beats a bare “did not match”, and otherwise the later branch wins, as in winnow.

type Inner = Error

Generally, Self

fn from_input(input: &Argv<'i>) -> Self

Creates an error from the input position

fn is_backtrack(&self) -> bool

Is backtracking and trying new parse branches allowed?

fn into_inner(self) -> Result<Self::Inner, Self>

Unwrap the mode, returning the underlying error, if present

fn assert(input: &I, _message: &'static str) -> Self

where I: Debug,

Process a parser assertion

fn incomplete(input: &I, _needed: Needed) -> Self

There was not enough data to determine the appropriate action

fn append(self, _input: &I, _token_start: &<I as Stream>::Checkpoint) -> Self

Like ParserError::from_input but merges it with the existing error.

fn is_incomplete(&self) -> bool

Is more data Needed

fn needed(&self) -> Option<Needed>

Extract the Needed data, if present

impl<'i> PartialEq for Argv<'i>

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

Equality operator ==.

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

Inequality operator !=.

impl SliceLen for Argv<'_>

fn slice_len(&self) -> usize

Calculates the input length, as indicated by its name, and the name of the trait itself

impl<'i> Stream for Argv<'i>

Tokens are words (the unread part of the current one first); slices are runs of whole words, so next_slice must not be asked to split a word.

type Token = &'i BStr

The smallest unit being parsed

type Slice = &'i [&'i BStr]

Sequence of Tokens

type IterOffsets = IterOffsets<'i>

Iterate with the offset from the current location

type Checkpoint = Argv<'i>

A parse location within the stream

fn iter_offsets(&self) -> Self::IterOffsets

Iterate with the offset from the current location

fn eof_offset(&self) -> usize

Returns the offset to the end of the input

fn next_token(&mut self) -> Option<Self::Token>

Split off the next token from the input

fn peek_token(&self) -> Option<Self::Token>

Split off the next token from the input

fn offset_for<P>(&self, predicate: P) -> Option<usize>

where P: Fn(Self::Token) -> bool,

Finds the offset of the next matching token

fn offset_at(&self, tokens: usize) -> Result<usize, Needed>

Get the offset for the number of tokens into the stream

fn next_slice(&mut self, offset: usize) -> Self::Slice

Split off a slice of tokens from the input

fn peek_slice(&self, offset: usize) -> Self::Slice

Split off a slice of tokens from the input

fn checkpoint(&self) -> Self::Checkpoint

Save the current parse location within the stream

fn reset(&mut self, checkpoint: &Self::Checkpoint)

Revert the stream to a prior Self::Checkpoint

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

Write out a single-line summary of the current parse location

unsafe fn next_slice_unchecked(&mut self, offset: usize) -> Self::Slice

Split off a slice of tokens from the input

unsafe fn peek_slice_unchecked(&self, offset: usize) -> Self::Slice

Split off a slice of tokens from the input

fn finish(&mut self) -> Self::Slice

Advance to the end of the stream

fn peek_finish(&self) -> Self::Slice

where Self: Clone,

Advance to the end of the stream

impl StreamIsPartial for Argv<'_>

type PartialState = ()

Whether the stream is currently partial or complete

fn complete(&mut self) -> Self::PartialState

Mark the stream is complete

fn restore_partial(&mut self, _state: Self::PartialState)

Restore the stream back to its previous state

fn is_partial_supported() -> bool

Report whether the Stream is can ever be incomplete

fn is_partial(&self) -> bool

Report whether the Stream is currently incomplete

impl<'i> StructuralPartialEq for Argv<'i>