Result struct

Success

Result.Success is an compile-time constant (enum) that represents a successful result of an operation.

Signature

Error

Result.Error is a function that returns a failed result of an operation.

Signature

Parameters

• resultCode

  Result/exit code of an operation.

• msg

  Text of an error message.

• extraArgs

  Additional arguments that are added to the text of an error message.

Notes

• msg and extraArgs are converted to a single error message string using std.conv.text(msg, extraArgs).

• Error message supports ANSI styling. See ANSI coloring and styling how to use.

• Error message is passed to Config.errorHandler if it's set or printed to stderr otherwise by CLI API at the end of parsing.

Return value

Result object that represents the failed result of an operation.

exitCode

Result.exitCode is a property that returns the result/exit code. It's supposed to be returned from main() function.

Signature

Return value

Result/exit code of an operation.

isSuccess

Result.isSuccess can be used to determine whether result of an operation is successful.

Signature

Return value

• true if operation is successful.

• false otherwise.

isError

Result.isError can be used to determine whether result of an operation is error.

Signature

Return value

• true if the result is error.

• false otherwise.

isHelpWanted

Result.isHelpWanted can be used to determine whether the help text was requested from command line (i.e. -h/--help argument was provided).

Signature

Return value

• true if help text was requested.

• false otherwise.

opCast

Result.opCast is the same as Result.isSuccess.

Signature

Return value

• true if operation is successful.

• false otherwise.