Help

[Source]

primitive val Help

Constructors

create

[Source]

new val create()
: Help val^

Returns

• Help val^

---

Public Functions

general

[Source]

Creates a command help that can print a general program help message.

fun box general(
  cs: CommandSpec box)
: CommandHelp box

Parameters

• cs: CommandSpec box

Returns

• CommandHelp box

---

for_command

[Source]

Creates a command help for a specific command that can print a detailed help message.

fun box for_command(
  cs: CommandSpec box,
  argv: Array[String val] box)
: (CommandHelp box | SyntaxError val)

Parameters

• cs: CommandSpec box
• argv: Array[String val] box

Returns

• (CommandHelp box | SyntaxError val)

---

eq

[Source]

fun box eq(
  that: Help val)
: Bool val

Parameters

• that: Help val

Returns

• Bool val

---

ne

[Source]

fun box ne(
  that: Help val)
: Bool val

Parameters

• that: Help val

Returns

• Bool val

---

Private Functions

_parse

[Source]

fun box _parse(
  cs: CommandSpec box,
  ch: CommandHelp box,
  argv: Array[String val] box)
: (CommandHelp box | SyntaxError val)

Parameters

• cs: CommandSpec box
• ch: CommandHelp box
• argv: Array[String val] box

Returns

• (CommandHelp box | SyntaxError val)

---