Struct OptSpec 

pub struct OptSpec<'a, Ctx: ?Sized> { /* private fields */ }

Option (flag or value-bearing).

Implementations

impl<'a, Ctx: ?Sized> OptSpec<'a, Ctx>

pub fn flag<F>(name: &'a str, cb: F) -> Self

where F: Fn(&mut Ctx) + 'a,

Create a flag option. Other fields are set via builder methods.

pub fn flag_try<F, E>(name: &'a str, cb: F) -> Self

where F: Fn(&mut Ctx) -> Result<(), E> + 'a, E: Error + Send + Sync + 'static,

Create a flag option with a fallible callback.

pub fn value<F>(name: &'a str, cb: F) -> Self

where F: Fn(&OsStr, &mut Ctx) + 'a,

Create a value option. Other fields are set via builder methods.

pub fn value_try<F, E>(name: &'a str, cb: F) -> Self

where F: Fn(&OsStr, &mut Ctx) -> Result<(), E> + 'a, E: Error + Send + Sync + 'static,

Create a value option with a fallible callback.

pub fn short(self, s: char) -> Self

pub fn long(self, l: &'a str) -> Self

pub fn metavar(self, mv: &'a str) -> Self

pub fn help(self, h: &'a str) -> Self

pub fn env(self, name: &'a str) -> Self

pub fn default(self, val: impl Into<OsString>) -> Self

pub fn group(self, g: &'a str) -> Self

pub fn single(self) -> Self

pub fn repeatable(self) -> Self

pub fn validator<F, E>(self, v: F) -> Self

where F: Fn(&OsStr) -> Result<(), E> + 'a, E: Display,

Value validator that returns a displayable error (converted into Error::User).

pub fn validator_try<F, E>(self, v: F) -> Self

where F: Fn(&OsStr) -> Result<(), E> + 'a, E: Error + Send + Sync + 'static,

Value validator that returns a typed error (boxed into Error::UserAny).

pub fn get_name(&self) -> &str

pub fn get_short(&self) -> Option<char>

pub fn get_long(&self) -> Option<&str>

pub fn get_metavar(&self) -> Option<&str>

pub fn get_help(&self) -> Option<&str>

pub fn get_env(&self) -> Option<&str>

pub fn get_default(&self) -> Option<&OsString>

pub fn get_group(&self) -> Option<&str>

pub fn is_value(&self) -> bool

pub fn get_repeat(&self) -> Repeat

pub fn get_on_value(&self) -> Option<&OnValueFn<'a, Ctx>>

pub fn get_on_flag(&self) -> Option<&OnFlagFn<'a, Ctx>>

pub fn get_validator(&self) -> Option<&ValueValidatorFn<'a>>