OptionSpec

[Источник]

OptionSpec описывает спецификацию именованного параметра. У них есть имя, описание, короткое имя, тип и значение по умолчанию, если они не обязательны.

Параметры могут быть размещены где угодно перед или после команд и могут рассматриваться как именованные аргументы.

class val OptionSpec

Конструкторы

bool

[Источник]

Создаёт параметр с булевым типом значения, который можно использовать, как --opt или -O или --opt=true или -O=true, чтобы получить значение параметра, как 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^

Параметры

• name': Строка val
• descr': Строка val = ""
• short': (U8 val | None val) = ссылка
• default': (Булево val | None val) = ссылка

Возвращает

• OptionSpec val^

string

[Источник]

Создаёт параметр со строковым типом значения, который можно использовать, как --file=dir/filename или -F=dir/filename или -Fdir/filename чтобы получить значение параметра, как 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^

Параметры

• name': Строка val
• descr': Строка val = ""
• short': (U8 val | None val) = ссылка
• default': (Строка val | None val) = ссылка

Возвращает

• OptionSpec val^

i64

[Источник]

Создаёт параметр с типом значения I64, который можно использовать, как --count=42 -C=42 , чтобы получить значение параметра, как 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^

Параметры

• name': Строка val
• descr': Строка val = ""
• short': (U8 val | None val) = ссылка
• default': (I64 val | None val) = ссылка

Возвращает

• OptionSpec val^

u64

[Источник]

Создаёт параметр с типом значения U64, который можно использовать, как --count=47 -C=47 , чтобы получить значение параметра, как 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^

Параметры

• name': Строка val
• descr': Строка val = ""
• short': (U8 val | None val) = ссылка
• default': (U64 val | None val) = ссылка

Возвращает

• OptionSpec val^

f64

[Источник]

Создаёт параметр с типом значения F64, который можно использовать, как --ratio=1.039 или -R=1.039 , чтобы получить значение параметра, как 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^

Параметры

• name': Строка val
• descr': Строка val = ""
• short': (U8 val | None val) = ссылка
• default': (F64 val | None val) = ссылка

Возвращает

• OptionSpec val^

string_seq

[Источник]

Создаёт параметр с типом значения ReadSeq[String], который можно использовать, как --files=file1 --files=files2 --files=files2 , чтобы получить последовательность из трёх строк, эквивалентных 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^

Параметры

• name': Строка val
• descr': Строка val = ""
• short': (U8 val | None val) = ссылка

Возвращает

• OptionSpec val^

Публичные функции

name

[Источник]

Возвращает имя этого параметра.

fun box name()
: String val

Возвращает

• Строка val

descr

[Источник]

Возвращает описание этого параметра.

fun box descr()
: String val

Возвращает

• Строка val

required

[Источник]

Возвращает true, если этот параметр должен быть присутствовать в командной строке.

fun box required()
: Bool val

Возвращает

• Булево val

help_string

[Источник]

Возвращает отформатированную строку справки для этого параметра.

fun box help_string()
: String val

Возвращает

• Строка val

deb_string

[Источник]

fun box deb_string()
: String val

Возвращает

• Строка val