ArgSpec

[Источник]

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

Аргументы всегда следуют за листом команды и присваиваются в их позиционном порядке.

class val ArgSpec

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

bool

[Источник]

Создаёт аргумент с булевым типом значения, который может использоваться как <cmd> true для получения значения аргумента, как cmd.arg("opt").bool() == true.

new val bool(
  name': String val,
  descr': String val = "",
  default': (Bool val | None val) = reference)
: ArgSpec val^

Параметры

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

Возвращаемое значение

• ArgSpec val^

string

[Источник]

Создаёт аргумент со строковым типом значения, который может использоваться как <cmd> filename для получения значения аргумента cmd.arg("file").string() == "filename".

new val string(
  name': String val,
  descr': String val = "",
  default': (String val | None val) = reference)
: ArgSpec val^

Параметры

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

Возвращаемое значение

• ArgSpec val^

i64

[Источник]

Создаёт аргумент с типом значения I64, который может использоваться как <cmd> 42 для получения значения аргумента, как cmd.arg("count").i64() == I64(42).

new val i64(
  name': String val,
  descr': String val = "",
  default': (I64 val | None val) = reference)
: ArgSpec val^

Параметры

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

Возвращаемое значение

• ArgSpec val^

u64

[Источник]

Создаёт аргумент с типом значения U64, который может использоваться как <cmd> 47 для получения значения аргумента, как cmd.arg("count").u64() == U64(47).

new val u64(
  name': String val,
  descr': String val = "",
  default': (U64 val | None val) = reference)
: ArgSpec val^

Параметры

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

Возвращаемое значение

• ArgSpec val^

f64

[Источник]

Создаёт аргумент с типом значения F64, который может использоваться как <cmd> 1.039 для получения значения аргумента, как cmd.arg("ratio").f64() == F64(1.039).

new val f64(
  name': String val,
  descr': String val = "",
  default': (F64 val | None val) = reference)
: ArgSpec val^

Параметры

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

Возвращаемое значение

• ArgSpec val^

string_seq

[Источник]

Создаёт аргумент с типом значения ReadSeq[String], который может использоваться как <cmd> file1 file2 file3 для получения последовательности из трёх строк, эквивалентной cmd.arg("file").string_seq() (equiv) ["file1"; "file2"; "file3"].

new val string_seq(
  name': String val,
  descr': String val = "")
: ArgSpec val^

Параметры

• name': Строка val
• descr': Строка val = ""

Возвращаемое значение

• ArgSpec 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