Documentation
¶
Overview ¶
Package errdefs defines a set of error interfaces that packages should use for communicating classes of errors. Errors that cross the package boundary should implement one (and only one) of these interfaces.
Packages should not reference these interfaces directly, only implement them. To check if a particular error implements one of these interfaces, there are helper functions provided (e.g. `Is<SomeError>`) which can be used rather than asserting the interfaces directly. If you must assert on these interfaces, be sure to check the causal chain (`err.Cause()`).
Index ¶
- func Cancelled(err error) error
- func Conflict(err error) error
- func DataLoss(err error) error
- func Deadline(err error) error
- func Forbidden(err error) error
- func FromContext(ctx context.Context) error
- func FromStatusCode(err error, statusCode int) error
- func InvalidParameter(err error) error
- func IsCancelled(err error) bool
- func IsConflict(err error) bool
- func IsContext(err error) bool
- func IsDataLoss(err error) bool
- func IsDeadline(err error) bool
- func IsForbidden(err error) bool
- func IsInvalidParameter(err error) bool
- func IsNotFound(err error) bool
- func IsNotImplemented(err error) bool
- func IsNotModified(err error) bool
- func IsSystem(err error) bool
- func IsUnauthorized(err error) bool
- func IsUnavailable(err error) bool
- func IsUnknown(err error) bool
- func NotFound(err error) error
- func NotImplemented(err error) error
- func NotModified(err error) error
- func System(err error) error
- func Unauthorized(err error) error
- func Unavailable(err error) error
- func Unknown(err error) error
- type ErrCancelled
- type ErrConflict
- type ErrDataLoss
- type ErrDeadline
- type ErrForbidden
- type ErrInvalidParameter
- type ErrNotFound
- type ErrNotImplemented
- type ErrNotModified
- type ErrSystem
- type ErrUnauthorized
- type ErrUnavailable
- type ErrUnknown
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Cancelled ¶
Cancelled creates an ErrCancelled error from the given error. It returns the error as-is if it is either nil (no error) or already implements ErrCancelled,
func Conflict ¶
Conflict creates an ErrConflict error from the given error. It returns the error as-is if it is either nil (no error) or already implements ErrConflict,
func DataLoss ¶
DataLoss creates an ErrDataLoss error from the given error. It returns the error as-is if it is either nil (no error) or already implements ErrDataLoss,
func Deadline ¶
Deadline creates an ErrDeadline error from the given error. It returns the error as-is if it is either nil (no error) or already implements ErrDeadline,
func Forbidden ¶
Forbidden creates an ErrForbidden error from the given error. It returns the error as-is if it is either nil (no error) or already implements ErrForbidden,
func FromContext ¶
FromContext returns the error class from the passed in context
func FromStatusCode ¶
FromStatusCode creates an errdef error, based on the provided HTTP status-code
func InvalidParameter ¶
InvalidParameter creates an ErrInvalidParameter error from the given error. It returns the error as-is if it is either nil (no error) or already implements ErrInvalidParameter,
func IsCancelled ¶
IsCancelled returns if the passed in error is an ErrCancelled.
func IsConflict ¶
IsConflict returns if the passed in error is an ErrConflict.
func IsContext ¶
IsContext returns if the passed in error is due to context cancellation or deadline exceeded.
func IsDataLoss ¶
IsDataLoss returns if the passed in error is an ErrDataLoss.
func IsDeadline ¶
IsDeadline returns if the passed in error is an ErrDeadline.
func IsForbidden ¶
IsForbidden returns if the passed in error is an ErrForbidden.
func IsInvalidParameter ¶
IsInvalidParameter returns if the passed in error is an ErrInvalidParameter.
func IsNotFound ¶
IsNotFound returns if the passed in error is an ErrNotFound,
func IsNotImplemented ¶
IsNotImplemented returns if the passed in error is an ErrNotImplemented.
func IsNotModified ¶
IsNotModified returns if the passed in error is an ErrNotModified.
func IsUnauthorized ¶
IsUnauthorized returns if the passed in error is an ErrUnauthorized.
func IsUnavailable ¶
IsUnavailable returns if the passed in error is an ErrUnavailable.
func IsUnknown ¶
IsUnknown returns if the passed in error is an ErrUnknown.
func NotFound ¶
NotFound creates an ErrNotFound error from the given error. It returns the error as-is if it is either nil (no error) or already implements ErrNotFound,
func NotImplemented ¶
NotImplemented creates an ErrNotImplemented error from the given error. It returns the error as-is if it is either nil (no error) or already implements ErrNotImplemented,
func NotModified ¶
NotModified creates an ErrNotModified error from the given error. It returns the error as-is if it is either nil (no error) or already implements NotModified,
func System ¶
System creates an ErrSystem error from the given error. It returns the error as-is if it is either nil (no error) or already implements ErrSystem,
func Unauthorized ¶
Unauthorized creates an ErrUnauthorized error from the given error. It returns the error as-is if it is either nil (no error) or already implements ErrUnauthorized,
func Unavailable ¶
Unavailable creates an ErrUnavailable error from the given error. It returns the error as-is if it is either nil (no error) or already implements ErrUnavailable,
func Unknown ¶
Unknown creates an ErrUnknown error from the given error. It returns the error as-is if it is either nil (no error) or already implements ErrUnknown,
Types ¶
type ErrCancelled ¶
type ErrCancelled interface {
Cancelled()
}
ErrCancelled signals that the action was cancelled.
type ErrConflict ¶
type ErrConflict interface {
Conflict()
}
ErrConflict signals that some internal state conflicts with the requested action and can't be performed. A change in state should be able to clear this error.
type ErrDataLoss ¶
type ErrDataLoss interface {
DataLoss()
}
ErrDataLoss indicates that data was lost or there is data corruption.
type ErrDeadline ¶
type ErrDeadline interface {
DeadlineExceeded()
}
ErrDeadline signals that the deadline was reached before the action completed.
type ErrForbidden ¶
type ErrForbidden interface {
Forbidden()
}
ErrForbidden signals that the requested action cannot be performed under any circumstances. When a ErrForbidden is returned, the caller should never retry the action.
type ErrInvalidParameter ¶
type ErrInvalidParameter interface {
InvalidParameter()
}
ErrInvalidParameter signals that the user input is invalid
type ErrNotFound ¶
type ErrNotFound interface {
NotFound()
}
ErrNotFound signals that the requested object doesn't exist
type ErrNotImplemented ¶
type ErrNotImplemented interface {
NotImplemented()
}
ErrNotImplemented signals that the requested action/feature is not implemented on the system as configured.
type ErrNotModified ¶
type ErrNotModified interface {
NotModified()
}
ErrNotModified signals that an action can't be performed because it's already in the desired state
type ErrSystem ¶
type ErrSystem interface {
System()
}
ErrSystem signals that some internal error occurred. An example of this would be a failed mount request.
type ErrUnauthorized ¶
type ErrUnauthorized interface {
}
ErrUnauthorized is used to signify that the user is not authorized to perform a specific action
type ErrUnavailable ¶
type ErrUnavailable interface {
}
ErrUnavailable signals that the requested action/subsystem is not available.
type ErrUnknown ¶
type ErrUnknown interface {
Unknown()
}
ErrUnknown signals that the kind of error that occurred is not known.
Source Files