Struct ArgumentTraverser

pub struct ArgumentTraverser<'cmd> { /* private fields */ }

Iterates over the individual arguments in a command accounting for quoted arguments.

Implementations

impl<'cmd> ArgumentTraverser<'cmd>

pub fn new(command: &'cmd str) -> Self

Creates a traverser over the given command, stripping off the initial ‘/’ if it exists.

pub fn gobble_remaining(&mut self) -> &'cmd str

Returns the remaining portion of the string being traversed, including the argument which was last read.

pub fn gobble_remaining_truncated(&self, truncate_to: usize) -> &'cmd str

Returns the remaining portion of the string being traversed from the current anchor position to the end of the string.

pub fn has_next(&self) -> bool

Returns whether or not this traverser has more arguments. If this function returns true, then next will not return None.

pub fn next(&mut self) -> Option<&'cmd str>

Returns the next argument in the string being traversed, or None if no arguments remain. This function will not strip strings of any enclosing quotes, and will not resolve escape sequences.