Skip to main content

Arg

Struct Arg 

Source
pub struct Arg {
    pub arg_type: ArgType,
    pub short: Option<&'static str>,
    pub long: Option<&'static str>,
    pub required: bool,
    pub value: Option<OsString>,
}
Expand description

Represents a type-safe argument specification.

Fields§

§arg_type: ArgType

The argument type

§short: Option<&'static str>

Short form (e.g., -v)

§long: Option<&'static str>

Long form (e.g., --verbose)

§required: bool

Whether this argument is required

§value: Option<OsString>

The argument value (if any)

Implementations§

Source§

impl Arg

Source

pub fn flag(short: &'static str, long: &'static str) -> Self

Creates a new required flag argument.

Source

pub fn optional_flag(short: &'static str, long: &'static str) -> Self

Creates a new optional flag argument.

Source

pub fn option(short: &'static str, long: &'static str) -> Self

Creates a new required option argument.

Source

pub fn optional_option(short: &'static str, long: &'static str) -> Self

Creates a new optional option argument.

Source

pub fn positional() -> Self

Creates a new positional argument.

Source

pub fn optional_positional() -> Self

Creates a new optional positional argument.

Source

pub fn value<V: AsRef<OsStr>>(self, value: V) -> Self

Sets the value for this argument.

Source

pub fn to_strings(&self) -> Vec<OsString>

Converts this argument to command-line strings.

Trait Implementations§

Source§

impl Clone for Arg

Source§

fn clone(&self) -> Arg

Returns a duplicate 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 Arg

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Arg

§

impl RefUnwindSafe for Arg

§

impl Send for Arg

§

impl Sync for Arg

§

impl Unpin for Arg

§

impl UnsafeUnpin for Arg

§

impl UnwindSafe for Arg

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

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>,

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.