Struct ArgumentParser

Source
pub struct ArgumentParser { /* private fields */ }

Implementations§

Source§

impl ArgumentParser

Source

pub fn new(name: &str) -> Self

Constructor for the argument parser.

Source

pub fn name(&self) -> &str

The name of the parser.

Source

pub fn argument_count(&self) -> usize

The number of arguments currently registered with the parser.

Source

pub fn with_author(self, author: &str)

Source

pub fn with_description(self, description: &str)

Source

pub fn with_argument(self, argument: Argument) -> Self

Source

pub fn compile(self, args: &[String]) -> Vec<ParsedArgument>

Compiles a slice of Strings into an array of Parsed Arguments. This will move the parser into this function and return back the parsed arguments if everything succeeds. This function assumes that the first item within args is the name of the executable being run. (Which is the standard for arguments passed in from std::env::args()). The ordering of the arguments returned is always the same as order they’re registered in with the parser.

Auto Trait Implementations§

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,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
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>,

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.