Documentation
¶
Overview ¶
Package status defines a full featured error type.
Index ¶
- func ReplaceOrSuppress(dst *S, sts S)
- type S
- func Aborted(e error, v ...interface{}) S
- func Abortedf(e error, format string, v ...interface{}) S
- func AlreadyExists(e error, v ...interface{}) S
- func AlreadyExistsf(e error, format string, v ...interface{}) S
- func Canceled(e error, v ...interface{}) S
- func Canceledf(e error, format string, v ...interface{}) S
- func DataLoss(e error, v ...interface{}) S
- func DataLossf(e error, format string, v ...interface{}) S
- func DeadlineExceeded(e error, v ...interface{}) S
- func DeadlineExceededf(e error, format string, v ...interface{}) S
- func FailedPrecondition(e error, v ...interface{}) S
- func FailedPreconditionf(e error, format string, v ...interface{}) S
- func From(err error) S
- func Internal(e error, v ...interface{}) S
- func Internalf(e error, format string, v ...interface{}) S
- func InvalidArgument(e error, v ...interface{}) S
- func InvalidArgumentf(e error, format string, v ...interface{}) S
- func NotFound(e error, v ...interface{}) S
- func NotFoundf(e error, format string, v ...interface{}) S
- func OutOfRange(e error, v ...interface{}) S
- func OutOfRangef(e error, format string, v ...interface{}) S
- func PermissionDenied(e error, v ...interface{}) S
- func PermissionDeniedf(e error, format string, v ...interface{}) S
- func ResourceExhausted(e error, v ...interface{}) S
- func ResourceExhaustedf(e error, format string, v ...interface{}) S
- func Unauthenticated(e error, v ...interface{}) S
- func Unauthenticatedf(e error, format string, v ...interface{}) S
- func Unavailable(e error, v ...interface{}) S
- func Unavailablef(e error, format string, v ...interface{}) S
- func Unimplemented(e error, v ...interface{}) S
- func Unimplementedf(e error, format string, v ...interface{}) S
- func Unknown(e error, v ...interface{}) S
- func Unknownf(e error, format string, v ...interface{}) S
- func WithSuppressed(s S, suppressed ...error) S
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ReplaceOrSuppress ¶
Types ¶
type S ¶
type S interface {
error
fmt.Stringer
Code() codes.Code
Message() string
Cause() error
Stack() []uintptr
// contains filtered or unexported methods
}
func Aborted ¶
Aborted indicates the operation was aborted, typically due to a concurrency issue like sequencer check failures, transaction aborts, etc.
See litmus test above for deciding between FailedPrecondition, Aborted, and Unavailable.
func Abortedf ¶
Abortedf indicates the operation was aborted, typically due to a concurrency issue like sequencer check failures, transaction aborts, etc.
See litmus test above for deciding between FailedPrecondition, Aborted, and Unavailable.
func AlreadyExists ¶
AlreadyExists means an attempt to create an entity failed because one already exists.
func AlreadyExistsf ¶
AlreadyExists means an attempt to create an entity failed because one already exists.
func DeadlineExceeded ¶
DeadlineExceeded means operation expired before completion. For operations that change the state of the system, this error may be returned even if the operation has completed successfully. For example, a successful response from a server could have been delayed long enough for the deadline to expire.
func DeadlineExceededf ¶
DeadlineExceededf means operation expired before completion. For operations that change the state of the system, this error may be returned even if the operation has completed successfully. For example, a successful response from a server could have been delayed long enough for the deadline to expire.
func FailedPrecondition ¶
FailedPrecondition indicates operation was rejected because the system is not in a state required for the operation's execution. For example, directory to be deleted may be non-empty, an rmdir operation is applied to a non-directory, etc.
A litmus test that may help a service implementor in deciding between FailedPrecondition, Aborted, and Unavailable:
(a) Use Unavailable if the client can retry just the failing call.
(b) Use Aborted if the client should retry at a higher-level
(e.g., restarting a read-modify-write sequence).
(c) Use FailedPrecondition if the client should not retry until
the system state has been explicitly fixed. E.g., if an "rmdir"
fails because the directory is non-empty, FailedPrecondition
should be returned since the client should not retry unless
they have first fixed up the directory by deleting files from it.
(d) Use FailedPrecondition if the client performs conditional
REST Get/Update/Delete on a resource and the resource on the
server does not match the condition. E.g., conflicting
read-modify-write on the same resource.
func FailedPreconditionf ¶
FailedPreconditionf indicates operation was rejected because the system is not in a state required for the operation's execution. For example, directory to be deleted may be non-empty, an rmdir operation is applied to a non-directory, etc.
A litmus test that may help a service implementor in deciding between FailedPrecondition, Aborted, and Unavailable:
(a) Use Unavailable if the client can retry just the failing call.
(b) Use Aborted if the client should retry at a higher-level
(e.g., restarting a read-modify-write sequence).
(c) Use FailedPrecondition if the client should not retry until
the system state has been explicitly fixed. E.g., if an "rmdir"
fails because the directory is non-empty, FailedPrecondition
should be returned since the client should not retry unless
they have first fixed up the directory by deleting files from it.
(d) Use FailedPrecondition if the client performs conditional
REST Get/Update/Delete on a resource and the resource on the
server does not match the condition. E.g., conflicting
read-modify-write on the same resource.
func Internal ¶
Internal errors. Means some invariants expected by underlying system has been broken. If you see one of these errors, something is very broken.
func Internalf ¶
Internal errors. Means some invariants expected by underlying system has been broken. If you see one of these errors, something is very broken.
func InvalidArgument ¶
InvalidArgument indicates client specified an invalid argument. Note that this differs from FailedPrecondition. It indicates arguments that are problematic regardless of the state of the system (e.g., a malformed file name).
func InvalidArgumentf ¶
InvalidArgumentf indicates client specified an invalid argument. Note that this differs from FailedPrecondition. It indicates arguments that are problematic regardless of the state of the system (e.g., a malformed file name).
func OutOfRange ¶
OutOfRange means operation was attempted past the valid range. E.g., seeking or reading past end of file.
Unlike InvalidArgument, this error indicates a problem that may be fixed if the system state changes. For example, a 32-bit file system will generate InvalidArgument if asked to read at an offset that is not in the range [0,2^32-1], but it will generate OutOfRange if asked to read from an offset past the current file size.
There is a fair bit of overlap between FailedPrecondition and OutOfRange. We recommend using OutOfRange (the more specific error) when it applies so that callers who are iterating through a space can easily look for an OutOfRange error to detect when they are done.
func OutOfRangef ¶
OutOfRangef means operation was attempted past the valid range. E.g., seeking or reading past end of file.
Unlike InvalidArgument, this error indicates a problem that may be fixed if the system state changes. For example, a 32-bit file system will generate InvalidArgument if asked to read at an offset that is not in the range [0,2^32-1], but it will generate OutOfRange if asked to read from an offset past the current file size.
There is a fair bit of overlap between FailedPrecondition and OutOfRange. We recommend using OutOfRange (the more specific error) when it applies so that callers who are iterating through a space can easily look for an OutOfRange error to detect when they are done.
func PermissionDenied ¶
PermissionDenied indicates the caller does not have permission to execute the specified operation. It must not be used for rejections caused by exhausting some resource (use ResourceExhausted instead for those errors). It must not be used if the caller cannot be identified (use Unauthenticated instead for those errors).
func PermissionDeniedf ¶
PermissionDeniedf indicates the caller does not have permission to execute the specified operation. It must not be used for rejections caused by exhausting some resource (use ResourceExhausted instead for those errors). It must not be used if the caller cannot be identified (use Unauthenticated instead for those errors).
func ResourceExhausted ¶
ResourceExhausted indicates some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space.
func ResourceExhaustedf ¶
ResourceExhaustedf indicates some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space.
func Unauthenticated ¶
Unauthenticated indicates the request does not have valid authentication credentials for the operation.
func Unauthenticatedf ¶
Unauthenticatedf indicates the request does not have valid authentication credentials for the operation.
func Unavailable ¶
Unavailable indicates the service is currently unavailable. This is a most likely a transient condition and may be corrected by retrying with a backoff.
See litmus test above for deciding between FailedPrecondition, Aborted, and Unavailable.
func Unavailablef ¶
Unavailablef indicates the service is currently unavailable. This is a most likely a transient condition and may be corrected by retrying with a backoff.
See litmus test above for deciding between FailedPrecondition, Aborted, and Unavailable.
func Unimplemented ¶
Unimplemented indicates operation is not implemented or not supported/enabled in this service.
func Unimplementedf ¶
Unimplementedf indicates operation is not implemented or not supported/enabled in this service.
func Unknown ¶
Unknown error. An example of where this error may be returned is if a Status value received from another address space belongs to an error-space that is not known in this address space. Also errors raised by APIs that do not return enough error information may be converted to this error.
func Unknownf ¶
Unknown error. An example of where this error may be returned is if a Status value received from another address space belongs to an error-space that is not known in this address space. Also errors raised by APIs that do not return enough error information may be converted to this error.
Source Files