OptionSpec¶
OptionSpec describes the specification of a named Option. They have a name, descr(iption), a short-name, a typ(e), and a default value when they are not required.
Options can be placed anywhere before or after commands, and can be thought of as named arguments.
class val OptionSpec
Constructors¶
bool¶
Creates an Option with a Bool typed value that can be used like
--opt
or -O
or --opt=true
or -O=true
to yield an option value like
cmd.option("opt").bool() == true
.
new val bool(
name': String val,
descr': String val = "",
short': (U8 val | None val) = reference,
default': (Bool val | None val) = reference)
: OptionSpec val^
Parameters¶
- name': String val
- descr': String val = ""
- short': (U8 val | None val) = reference
- default': (Bool val | None val) = reference
Returns¶
- OptionSpec val^
string¶
Creates an Option with a String typed value that can be used like
--file=dir/filename
or -F=dir/filename
or -Fdir/filename
to yield an option value like
cmd.option("file").string() == "dir/filename"
.
new val string(
name': String val,
descr': String val = "",
short': (U8 val | None val) = reference,
default': (String val | None val) = reference)
: OptionSpec val^
Parameters¶
- name': String val
- descr': String val = ""
- short': (U8 val | None val) = reference
- default': (String val | None val) = reference
Returns¶
- OptionSpec val^
i64¶
Creates an Option with an I64 typed value that can be used like
--count=42 -C=42
to yield an option value like
cmd.option("count").i64() == I64(42)
.
new val i64(
name': String val,
descr': String val = "",
short': (U8 val | None val) = reference,
default': (I64 val | None val) = reference)
: OptionSpec val^
Parameters¶
- name': String val
- descr': String val = ""
- short': (U8 val | None val) = reference
- default': (I64 val | None val) = reference
Returns¶
- OptionSpec val^
u64¶
Creates an Option with an U64 typed value that can be used like
--count=47 -C=47
to yield an option value like
cmd.option("count").u64() == U64(47)
.
new val u64(
name': String val,
descr': String val = "",
short': (U8 val | None val) = reference,
default': (U64 val | None val) = reference)
: OptionSpec val^
Parameters¶
- name': String val
- descr': String val = ""
- short': (U8 val | None val) = reference
- default': (U64 val | None val) = reference
Returns¶
- OptionSpec val^
f64¶
Creates an Option with a F64 typed value that can be used like
--ratio=1.039
or -R=1.039
to yield an option value like
cmd.option("ratio").f64() == F64(1.039)
.
new val f64(
name': String val,
descr': String val = "",
short': (U8 val | None val) = reference,
default': (F64 val | None val) = reference)
: OptionSpec val^
Parameters¶
- name': String val
- descr': String val = ""
- short': (U8 val | None val) = reference
- default': (F64 val | None val) = reference
Returns¶
- OptionSpec val^
string_seq¶
Creates an Option with a ReadSeq[String] typed value that can be used like
--files=file1 --files=files2 --files=files2
to yield a sequence of three strings equivalent to
cmd.option("ratio").string_seq() (equiv) ["file1"; "file2"; "file3"]
.
new val string_seq(
name': String val,
descr': String val = "",
short': (U8 val | None val) = reference)
: OptionSpec val^
Parameters¶
Returns¶
- OptionSpec val^
Public Functions¶
name¶
Returns the name of this option.
fun box name()
: String val
Returns¶
- String val
descr¶
Returns the description for this option.
fun box descr()
: String val
Returns¶
- String val
required¶
Returns true iff this option is required to be present in the command line.
fun box required()
: Bool val
Returns¶
- Bool val
help_string¶
Returns a formated help string for this option.
fun box help_string()
: String val
Returns¶
- String val
deb_string¶
fun box deb_string()
: String val
Returns¶
- String val