Documentation
¶
Overview ¶
Package exitcode centralizes cr's command-layer process exit taxonomy.
Index ¶
- Constants
- func AuthConfig(err error) error
- func ExactArgs(n int, msg string) cobra.PositionalArgs
- func FromError(err error) int
- func MaximumArgs(n int, msg string) cobra.PositionalArgs
- func NoArgs(msg string) cobra.PositionalArgs
- func NoArgsf(format string) cobra.PositionalArgs
- func NonEmptyArg(msg string) cobra.PositionalArgs
- func RangeArgs(minimum, maximum int, msg string) cobra.PositionalArgs
- func Upstream(err error) error
- func Usage(err error) error
- func With(code int, err error) error
Constants ¶
View Source
const ( // Success means the program completed successfully. Success = 0 // Failure is the generic non-usage failure code. Failure = 1 // UsageError means command syntax, flags, or arguments were invalid. UsageError = 2 // AuthConfigError means authentication or configuration prevented execution. AuthConfigError = 3 // UpstreamError means an upstream service or network failure prevented execution. UpstreamError = 5 )
Variables ¶
This section is empty.
Functions ¶
func AuthConfig ¶
AuthConfig marks err as an authentication or configuration error.
func ExactArgs ¶ added in v0.10.228
func ExactArgs(n int, msg string) cobra.PositionalArgs
ExactArgs requires exactly n positional arguments.
func MaximumArgs ¶ added in v0.10.228
func MaximumArgs(n int, msg string) cobra.PositionalArgs
MaximumArgs allows at most n positional arguments.
func NoArgs ¶ added in v0.10.228
func NoArgs(msg string) cobra.PositionalArgs
NoArgs rejects any positional arguments with the given usage message.
func NoArgsf ¶ added in v0.10.228
func NoArgsf(format string) cobra.PositionalArgs
NoArgsf rejects any positional arguments, formatting the message with the first argument.
func NonEmptyArg ¶ added in v0.10.228
func NonEmptyArg(msg string) cobra.PositionalArgs
NonEmptyArg requires a single non-empty positional argument.
Types ¶
This section is empty.
Click to show internal directories.
Click to hide internal directories.