Option

Represents an option.

Options hold any value as string (or array of strings). Options by default are optional, but can be marked as required.

Order in which options are passed does not matter.

class Option : IOption {

mixin OptionImpl ;

mixin EntryImpl ;

this(string name);

this(string abbrev, string full, string description);

typeof(this) tag(string tag);

string tag();

}

Constructors

this this(string name): Creates new option.
this this(string abbrev, string full, string description): Creates new option.

Members

Functions

tag typeof(this) tag(string tag): Sets option value tag.
tag string tag(): Option value tag.

Mixins

__anonymous mixin OptionImpl: Undocumented in source.
__anonymous mixin EntryImpl: Undocumented in source.

Mixed In Members

From `mixin OptionImpl`

displayName string displayName()
full typeof(this) full(string full)
full string full()
long_ alias long_ = full
abbrev typeof(this) abbrev(string abbrev)
abbrev string abbrev()
short_ alias short_ = abbrev

From `mixin EntryImpl`

name typeof(this) name(string name)
name string name()
description typeof(this) description(string description)
description string description()
repeating typeof(this) repeating(bool repeating)
isRepeating bool isRepeating()
required typeof(this) required(bool required)
optional typeof(this) optional(bool optional)
isRequired bool isRequired()
defaultValue typeof(this) defaultValue(string defaultValue)
defaultValue typeof(this) defaultValue(string[] defaultValue)
defaultValue string[] defaultValue()
validate typeof(this) validate(IValidator validator)
validators IValidator[] validators()

Inherited Members

From IOption

full typeof(this) full(string full): Sets option full name (long-form).
full string full()
long_ alias long_ = full: Option full name (long-form).
abbrev typeof(this) abbrev(string abbrev): Sets option abbrevation (short-form).
abbrev string abbrev()
short_ alias short_ = abbrev: Sets option abbrevation (short-form).

Meta

Source

See Implementation

commandr option classes

interfaces

mixin templates