Skip to main content

ArgvOptions

Struct ArgvOptions 

Source
pub struct ArgvOptions {
    pub boolean: Booleans,
    pub string: Vec<String>,
    pub alias: Vec<(String, Vec<String>)>,
    pub default: Vec<(String, Value)>,
    pub stop_early: bool,
    pub double_dash: bool,
    pub unknown: Option<UnknownFn>,
    pub camel_case: bool,
    pub parse_boolean: bool,
}
Expand description

Options for minimist and parse_argv.

Fields§

§boolean: Booleans

Boolean flags.

§string: Vec<String>

Flags whose values are always kept as strings ("_" for positionals).

§alias: Vec<(String, Vec<String>)>

Alias groups: key -> other names.

§default: Vec<(String, Value)>

Default values (dotted keys allowed).

§stop_early: bool

Stop parsing at the first positional argument.

§double_dash: bool

Put arguments after -- into "--" instead of "_".

§unknown: Option<UnknownFn>

Called for undeclared arguments.

§camel_case: bool

(parse_argv only) convert kebab-case keys to camelCase.

§parse_boolean: bool

(parse_argv only) turn "true"/"false" string values into booleans.

Implementations§

Source§

impl ArgvOptions

Source

pub fn new() -> Self

Empty options.

Source

pub fn boolean<S: AsRef<str>>(self, keys: &[S]) -> Self

Declare boolean flags.

Source

pub fn all_boolean(self) -> Self

Treat every long flag without = as boolean.

Source

pub fn string<S: AsRef<str>>(self, keys: &[S]) -> Self

Declare string flags.

Source

pub fn alias<S: AsRef<str>>(self, key: &str, names: &[S]) -> Self

Add an alias group.

Source

pub fn default_value(self, key: &str, value: impl Into<Value>) -> Self

Add a default value.

Source

pub fn stop_early(self) -> Self

Enable stop_early.

Source

pub fn double_dash(self) -> Self

Enable the "--" key.

Source

pub fn unknown(self, callback: UnknownFn) -> Self

Set the unknown-argument callback.

Source

pub fn camel_case(self) -> Self

Enable camelCase keys (parse_argv).

Source

pub fn parse_boolean(self) -> Self

Enable boolean parsing of values (parse_argv).

Trait Implementations§

Source§

impl Clone for ArgvOptions

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ArgvOptions

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ArgvOptions

Source§

fn default() -> Self

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

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> 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> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send> ⓘ

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
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 = !

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

fn try_from(value: U) -> Result<T, !>

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.