Enums

enum ArgumentMode

public enum ArgumentMode <: ToString & Equatable<ArgumentMode> {
    | NoValue
    | RequiredValue
    | OptionalValue
}

Description: Specifies the parameter mode of an option.

Parent types:

• ToString
• Equatable<ArgumentMode>

NoValue

NoValue

Description: Indicates that the value of an option does not exist.

OptionalValue

OptionalValue

Description: Indicates that the value of an option is optional.

RequiredValue

RequiredValue

Description: Indicates that the value of an option is mandatory.

func toString()

public func toString(): String

Description: Obtains a parameter mode string.

Returns:

• String: parameter mode string

operator func ==(ArgumentMode)

public operator func ==(that: ArgumentMode): Bool

Description: Checks whether two parameter modes are the same.

Parameters:

• that: ArgumentMode: parameter mode

Returns:

• Bool: If the two parameter modes are the same, true is returned. Otherwise, false is returned.

enum ArgumentSpec

public enum ArgumentSpec {
    | Short(Rune, ArgumentMode)
    | Short(Rune, ArgumentMode, (String) -> Unit)
    | Long(String, ArgumentMode)
    | Long(String, ArgumentMode, (String) -> Unit)
    | Full(String, Rune, ArgumentMode)
    | Full(String, Rune, ArgumentMode, (String) -> Unit)
    | NonOptions((Array<String>) -> Unit)
}

Description: Specifies parameter specifications.

Full(String, Rune, ArgumentMode)

Full(String, Rune, ArgumentMode)

Description: Indicates that both long and short options exist.

Full(String, Rune, ArgumentMode, (String) -> Unit)

Full(String, Rune, ArgumentMode, (String) -> Unit)

Description: Indicates that both long and short options exist and a lambda callback function is held.

Long(String, ArgumentMode)

Long(String, ArgumentMode)

Description: Indicates a long option specification.

Long(String, ArgumentMode, (String) -> Unit)

Long(String, ArgumentMode, (String) -> Unit)

Description: Indicates a long option and that a lambda callback function is held.

NonOptions((Array<String>) -> Unit)

NonOptions((Array<String>) -> Unit)

Description: Indicates a non-option.

Short(Rune, ArgumentMode)

Short(Rune, ArgumentMode)

Description: Indicates a short option.

Short(Rune, ArgumentMode, (String) -> Unit)

Short(Rune, ArgumentMode, (String) -> Unit)

Description: Indicates a short option and that a lambda callback function is held.