# Struct clap_lex::RawArgs

source · [−]

    pub struct RawArgs { /* private fields */ }

Expand description

Command-line arguments

## Implementations

source

### impl RawArgs

source

#### pub fn from_args() -> Self

NOTE: The argument returned will be the current binary.

##### Example

    let raw = clap_lex::RawArgs::from_args();
    let mut cursor = raw.cursor();
    let _bin = raw.next_os(&mut cursor);

    let mut paths = raw.remaining(&mut cursor).map(PathBuf::from).collect::<Vec<_>>();
    println!("{:?}", paths);

source

#### pub fn new(iter: impl IntoIterator<Item = impl Into<OsString>>) -> Self

##### Example

    let raw = clap_lex::RawArgs::new(["bin", "foo.txt"]);
    let mut cursor = raw.cursor();
    let _bin = raw.next_os(&mut cursor);

    let mut paths = raw.remaining(&mut cursor).map(PathBuf::from).collect::<Vec<_>>();
    println!("{:?}", paths);

source

#### pub fn cursor(&self) -> ArgCursor

Create a cursor for walking the arguments

##### Example

    let raw = clap_lex::RawArgs::new(["bin", "foo.txt"]);
    let mut cursor = raw.cursor();
    let _bin = raw.next_os(&mut cursor);

    let mut paths = raw.remaining(&mut cursor).map(PathBuf::from).collect::<Vec<_>>();
    println!("{:?}", paths);

source

#### pub fn next(&self, cursor: &mut ArgCursor) -> Option<ParsedArg<'_>>

Advance the cursor, returning the next `ParsedArg`

source

#### pub fn next_os(&self, cursor: &mut ArgCursor) -> Option<&OsStr>

Advance the cursor, returning a raw argument value.

source

#### pub fn peek(&self, cursor: &ArgCursor) -> Option<ParsedArg<'_>>

Return the next `ParsedArg`

source

#### pub fn peek_os(&self, cursor: &ArgCursor) -> Option<&OsStr>

Return a raw argument value.

source

#### pub fn remaining(&self, cursor: &mut ArgCursor) -> impl Iterator<Item = &OsStr>

Return all remaining raw arguments, advancing the cursor to the end

##### Example

    let raw = clap_lex::RawArgs::new(["bin", "foo.txt"]);
    let mut cursor = raw.cursor();
    let _bin = raw.next_os(&mut cursor);

    let mut paths = raw.remaining(&mut cursor).map(PathBuf::from).collect::<Vec<_>>();
    println!("{:?}", paths);

source

#### pub fn seek(&self, cursor: &mut ArgCursor, pos: SeekFrom)

Adjust the cursor’s position

source

#### pub fn insert(
&mut self,
cursor: &ArgCursor,
insert_items: impl IntoIterator<Item = impl Into<OsString>>
)

Inject arguments before the `RawArgs::next`

source

#### pub fn is_end(&self, cursor: &ArgCursor) -> bool

Any remaining args?

## Trait Implementations

source

### impl Clone for RawArgs

source

#### fn clone(&self) -> RawArgs

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from `source`. Read more

source

### impl Debug for RawArgs

source

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

Formats the value using the given formatter. Read more

source

### impl Default for RawArgs

source

#### fn default() -> RawArgs

Returns the “default value” for a type. Read more

source

### impl<I, T> From<I> for RawArgs where
I: Iterator<Item = T>,
T: Into<OsString>,

source

#### fn from(val: I) -> Self

Converts to this type from the input type.

source

### impl PartialEq<RawArgs> for RawArgs

source

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

This method tests for `self` and `other` values to be equal, and is used by `==`. Read more

source

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

This method tests for `!=`.

source

### impl Eq for RawArgs

source

### impl StructuralEq for RawArgs

source

### impl StructuralPartialEq for RawArgs

## Auto Trait Implementations

### impl RefUnwindSafe for RawArgs

### impl Send for RawArgs

### impl Sync for RawArgs

### impl Unpin for RawArgs

### impl UnwindSafe for RawArgs

## Blanket Implementations

source

### impl<T> Any for T where
T: 'static + ?Sized,

source

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more

source

### impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

### impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

#### fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

### impl<T> From<T> for T

const: unstable · source

#### fn from(t: T) -> T

Returns the argument unchanged.

source

### impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · source

#### fn into(self) -> U

Calls `U::from(self)`.

That is, this conversion is whatever the implementation of `From<T> for U` chooses to do.

source

### impl<T> ToOwned for T where
T: Clone,

#### type Owned = T

The resulting type after obtaining ownership.

source

#### fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

#### fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

### impl<T, U> TryFrom<U> for T where
U: Into<T>,

#### type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

source

### impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

#### type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.