Struct aopt::opt::AOpt

pub struct AOpt { /* private fields */ }

A multiple features option type.

Some types support by default, they all implement Infer. When create the option with creator using add_opt, the Creator will retrieve other informations from the infer type list on the table. When create the option from type using infer, the Creator will retrieve other informations from given type.

type	action	ignore name	styles	index	alias	default value	creator	infer type
bool	Action::Set	false	Style::Combined Style::Boolean	no	true	false	b	bool
i32	Action::App	false	Style::Argument	no	true	None	None	None
i64	Action::App	false	Style::Argument	no	true	None	i	i64
u32	Action::App	false	Style::Argument	no	true	None	None	None
u64	Action::App	false	Style::Argument	no	true	None	u	u64
f32	Action::App	false	Style::Argument	no	true	None	None	None
f64	Action::App	false	Style::Argument	no	true	None	f	f64
usize	Action::App	false	Style::Argument	no	true	None	None	None
isize	Action::App	false	Style::Argument	no	true	None	None	None
String	Action::App	false	Style::Argument	no	true	None	s	String
OsString	Action::App	false	Style::Argument	no	true	None	r	OsString
Cmd	Action::Set	false	Style::Cmd	Forward(1)	true	false	c	Cmd
Pos	Action::App	true	Style::Pos	yes	false	None	p	Pos
Main	Action::Null	true	Style::Main	AnyWhere	false	None	m	Main
Stdin	Action::Set	true	Style::Pos	AnyWhere	true	None	None	None

For the value parser support, see RawValParser.

Implementations

impl AOpt

pub fn new(name: AStr, type_id: TypeId, accessor: ValAccessor) -> Self

pub fn with_uid(self, uid: Uid) -> Self

Set the unique identifier of option.

pub fn with_name(self, name: AStr) -> Self

Set the name of option.

pub fn with_type(self, type: TypeId) -> Self

Set the type of option, see Ctor.

pub fn with_ignore_name(self, ignore_name: bool) -> Self

If the option will matching the name.

pub fn with_ignore_alias(self, ignore_alias: bool) -> Self

If the option will matching the alias.

pub fn with_ignore_index(self, ignore_index: bool) -> Self

If the option will matching the alias.

pub fn with_hint(self, hint: AStr) -> Self

Set the hint of option, such as --option.

pub fn with_help(self, help: AStr) -> Self

Set the help message of option.

pub fn with_action(self, action: Action) -> Self

Set the value action of option.

pub fn with_opt_help(self, help: Help) -> Self

Set the help of option.

pub fn with_style(self, styles: Vec<Style>) -> Self

Set the Style of option.

pub fn with_idx(self, index: Option<Index>) -> Self

Set the NOA index of option.

pub fn with_force(self, force: bool) -> Self

If the option is force required.

pub fn with_alias(self, alias: Option<Vec<AStr>>) -> Self

Set the alias of option.

pub fn with_accessor(self, value: ValAccessor) -> Self

Set the value accessor of option, it will used by Policy;

impl AOpt

pub fn set_name(&mut self, name: AStr) -> &mut Self

pub fn set_type(&mut self, type: TypeId) -> &mut Self

pub fn set_value(&mut self, value: ValAccessor) -> &mut Self

pub fn set_hint(&mut self, hint: AStr) -> &mut Self

pub fn set_help(&mut self, help: AStr) -> &mut Self

pub fn set_action(&mut self, action: Action) -> &mut Self

pub fn set_style(&mut self, styles: Vec<Style>) -> &mut Self

pub fn set_index(&mut self, index: Option<Index>) -> &mut Self

pub fn set_force(&mut self, force: bool) -> &mut Self

pub fn add_alias(&mut self, name: AStr) -> &mut Self

pub fn rem_alias(&mut self, name: &AStr) -> &mut Self

Trait Implementations

impl Debug for AOpt

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

Formats the value using the given formatter.

impl Opt for AOpt

fn reset(&mut self)

fn uid(&self) -> Uid

fn name(&self) -> &AStr

The name of option.

fn type(&self) -> &TypeId

The type of option.

fn hint(&self) -> &AStr

The help hint of option such as --flag.

fn help(&self) -> &AStr

The help message of option.

fn valid(&self) -> bool

fn matched(&self) -> bool

If the option matched.

fn force(&self) -> bool

If the option is force required.

fn action(&self) -> &Action

The associaed action of option.

fn index(&self) -> Option<&Index>

The index of option.

fn alias(&self) -> Option<&Vec<AStr>>

The alias the option.

fn accessor(&self) -> &ValAccessor

fn accessor_mut(&mut self) -> &mut ValAccessor

fn ignore_alias(&self) -> bool

fn ignore_name(&self) -> bool

fn ignore_index(&self) -> bool

fn set_uid(&mut self, uid: Uid)

fn set_matched(&mut self, matched: bool)

fn mat_style(&self, style: Style) -> bool

fn mat_force(&self, force: bool) -> bool

fn mat_name(&self, name: Option<&AStr>) -> bool

fn mat_alias(&self, name: &AStr) -> bool

fn mat_index(&self, index: Option<(usize, usize)>) -> bool

fn init(&mut self) -> Result<(), Error>