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
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^
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^
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^
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^
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^
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^
Returns the name of this option.
fun box name() : String val
Returns the description for this option.
fun box descr() : String val
Returns true iff this option is required to be present in the command line.
fun box required() : Bool val
Returns a formated help string for this option.
fun box help_string() : String val
fun box deb_string() : String val
fun tag _init(
typ': _ValueType val,
default': (Bool val | String val | I64 val |
U64 val | F64 val | _StringSeq val |
None val))
: (_ValueType val , (Bool val | String val | I64 val |
U64 val | F64 val | _StringSeq val) , Bool val)
fun box _typ_p() : _ValueType val
fun box _default_p()
: (Bool val | String val | I64 val |
U64 val | F64 val | _StringSeq val)
fun box _requires_arg() : Bool val
fun box _default_arg()
: (Bool val | String val | I64 val |
U64 val | F64 val | _StringSeq val)
fun box _has_short( sh: U8 val) : Bool val
© 2016-2018, The Pony Developers
© 2014-2015, Causality Ltd.
Licensed under the BSD 2-Clause License.
https://stdlib.ponylang.io/cli-OptionSpec