An abstraction over exit status.

Concretely this corresponds to an exit/return code for the binary (in the case of the dolmen binary or solver-like binaries).

In practice, the exact error code corresponding to a value of this type can be set later. This is useful so that users of the library can decide the codes, and among other things, ensure that error codes are stable.

Usual functions

Initialise all retcodes with the given association list. All codes that are not present in the list are assigned a arbitrary free return code. If ~full is true, and not all retcodes are present in the association list, then this function with raise a Failure _ exception.

Create a new exit code. The string given is used as a description for the exit code. The create code is active by default.

Return the actual integer associated to the code,

Category (used mainly for report documentation).

Return the list of all created error exit codes.

The 0 exit code, signalling everything ran fine.

Unexpected errors. This uses retcode 125 since this is also what cmdliner uses. This code will not appear in the list returned by rrors.

Generic exit code.

Exit code for parsing errors.

Exit codes for typing errors.

Exit with the given code (or abort if the exit code is marked as an abort code).

Whether an exit code is active.

Make the exit code abort instead of properly exiting.

Make the exit code properly exit.