Documentation
¶
Overview ¶
Package errors provides simple error handling primitives.
The traditional error handling idiom in Go is roughly akin to
if err != nil {
return err
}
which when applied recursively up the call stack results in error reports without context or debugging information. The errors package allows programmers to add context to the failure path in their code in a way that does not destroy the original value of the error.
Adding context to an error ¶
The errors.Wrap function returns a new error that adds context to the original error by recording a stack trace at the point Wrap is called, together with the supplied message. For example
_, err := ioutil.ReadAll(r)
if err != nil {
return errors.Wrap(err, "read failed")
}
Index ¶
- func As(err error, target interface{}) bool
- func Is(err, target error) bool
- func New(message string) error
- func Newf(format string, args ...interface{}) error
- func Status(code codes.Code, message string, details ...*errdetails.ErrorInfo) error
- func Unwrap(err error) error
- func Wrap(err error, message string) error
- func Wrapf(err error, format string, args ...interface{}) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func As ¶
As finds the first error in err's chain that matches target, and if one is found, sets target to that error value and returns true. Otherwise, it returns false.
The chain consists of err itself followed by the sequence of errors obtained by repeatedly calling Unwrap.
An error matches target if the error's concrete value is assignable to the value pointed to by target, or if the error has a method As(interface{}) bool such that As(target) returns true. In the latter case, the As method is responsible for setting target.
func Is ¶
Is reports whether any error in err's chain matches target.
The chain consists of err itself followed by the sequence of errors obtained by repeatedly calling Unwrap.
An error is considered to match a target if it is equal to that target or if it implements a method Is(error) bool such that Is(target) returns true.
func New ¶
New returns an error that formats as the given text. Each call to New returns a distinct error value even if the text is identical.
func Newf ¶
Newf returns an error that formats according to a format specifier. Each call to Newf returns a distinct error value even if the text is identical.
func Status ¶
Status represents an RPC status code, message, and details. It is immutable. Code represent a set of Status code tht will be translated from gRPC to HTTP if the error is meant to be consumed by an HTTP client.
| HTTP | gRPC | Description | |------|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------| | 200 | OK | No error. | | 400 | INVALID_ARGUMENT | Client specified an invalid argument. Check error message and error details for more information. | | 400 | FAILED_PRECONDITION | Request can not be executed in the current system state, such as deleting a non-empty directory. | | 400 | OUT_OF_RANGE | Client specified an invalid range. | | 401 | UNAUTHENTICATED | Request not authenticated due to missing, invalid, or expired OAuth token. | | 403 | PERMISSION_DENIED | Client does not have sufficient permission. This can happen because the OAuth token does not have the right scopes, the client doesn't have permission. | | 404 | NOT_FOUND | A specified resource is not found. | | 409 | ABORTED | Concurrency conflict, such as read-modify-write conflict. | | 409 | ALREADY_EXISTS | The resource that a client tried to create already exists. | | 429 | RESOURCE_EXHAUSTED | Either out of resource quota or reaching rate limiting. | | 499 | CANCELLED | Request cancelled by the client. | | 500 | DATA_LOSS | Unrecoverable data loss or data corruption. The client should report the error to the user. | | 500 | UNKNOWN | Unknown server error. Typically a server bug. | | 500 | INTERNAL | Internal server error. Typically a server bug. | | 501 | NOT_IMPLEMENTED | API method not implemented by the server. | | 502 | N/A | Network error occurred before reaching the server. Typically a network outage or misconfiguration. | | 503 | UNAVAILABLE | Service unavailable. Typically the server is down. | | 504 | DEADLINE_EXCEEDED | Request deadline exceeded. This will happen only if the caller sets a deadline that is shorter than the method's default deadline. |
details provide details error information appended to the status. It is optional but always good to add detail when applicable.
func Unwrap ¶
Unwrap returns the result of calling the Unwrap method on err, if err's type contains an Unwrap method returning error. Otherwise, Unwrap returns nil.
Types ¶
This section is empty.
Source Files