Struct Word 

pub struct Word<'i> {
    pub value: &'i BStr,
    pub offset: usize,
    pub after_separator: bool,
}

A word that is not a flag.

Fields

value: &'i BStr

The word.

offset: usize

Where it starts.

after_separator: bool

Whether it came after --, where no word names a subcommand.

Implementations

impl<'i> Word<'i>

pub fn split(&self, delimiter: u8) -> impl Iterator<Item = Word<'i>>

The pieces of the word between delimiters, each at its own offset.

pub fn convert<T: FromArg>(&self, name: &str) -> Result<T, Error>

Convert the word with FromArg; name is how errors refer to it.

pub fn value_as<T: FromArg>( &self, name: &'static str, ) -> impl Parser<Argv<'i>, T, Error>

Word::convert as a parser, for a dispatch! arm.

Trait Implementations

impl<'i> Clone for Word<'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 Word<'i>

impl<'i> Debug for Word<'i>

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

Formats the value using the given formatter.

impl<'i> Eq for Word<'i>

impl<'i> PartialEq for Word<'i>

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

Equality operator ==.

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

Inequality operator !=.

impl<'i> StructuralPartialEq for Word<'i>