yarpcerrors

package
Version: v1.57.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 1, 2021 License: MIT Imports: 5 Imported by: 100

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func AbortedErrorf

func AbortedErrorf(format string, args ...interface{}) error

AbortedErrorf returns a new Status with code CodeAborted by calling Newf(CodeAborted, format, args...).

func AlreadyExistsErrorf

func AlreadyExistsErrorf(format string, args ...interface{}) error

AlreadyExistsErrorf returns a new Status with code CodeAlreadyExists by calling Newf(CodeAlreadyExists, format, args...).

func CancelledErrorf

func CancelledErrorf(format string, args ...interface{}) error

CancelledErrorf returns a new Status with code CodeCancelled by calling Newf(CodeCancelled, format, args...).

func DataLossErrorf

func DataLossErrorf(format string, args ...interface{}) error

DataLossErrorf returns a new Status with code CodeDataLoss by calling Newf(CodeDataLoss, format, args...).

func DeadlineExceededErrorf

func DeadlineExceededErrorf(format string, args ...interface{}) error

DeadlineExceededErrorf returns a new Status with code CodeDeadlineExceeded by calling Newf(CodeDeadlineExceeded, format, args...).

func ErrorMessage deprecated

This function has been deprecated.
func ErrorMessage(err error) string

ErrorMessage returns the message for the given error, or "" if the given error is nil, or err.Error() if the given error is not a YARPC error or the YARPC error had no message.

Deprecated: Use FromError and Message instead.

func ErrorName deprecated

This function has been deprecated.
func ErrorName(err error) string

ErrorName returns the name for the given error, or "" if the given error is not a YARPC error created with NamedErrorf that has a non-empty name.

Deprecated: Use FromError and Name instead.

func FailedPreconditionErrorf

func FailedPreconditionErrorf(format string, args ...interface{}) error

FailedPreconditionErrorf returns a new Status with code CodeFailedPrecondition by calling Newf(CodeFailedPrecondition, format, args...).

func FromHeaders deprecated

This function has been deprecated.
func FromHeaders(code Code, name string, message string) error

FromHeaders returns a new Status from headers transmitted from the server side.

If the specified code is CodeOK, this will return nil.

The name must only contain lowercase letters from a-z and dashes (-), and cannot start or end in a dash. If the name is something else, an error with code CodeInternal will be returned.

This function should not be used by server implementations, use the individual error constructors instead. This should only be used by transport implementations.

Deprecated: Use Newf and WithName instead.

func InternalErrorf

func InternalErrorf(format string, args ...interface{}) error

InternalErrorf returns a new Status with code CodeInternal by calling Newf(CodeInternal, format, args...).

func InvalidArgumentErrorf

func InvalidArgumentErrorf(format string, args ...interface{}) error

InvalidArgumentErrorf returns a new Status with code CodeInvalidArgument by calling Newf(CodeInvalidArgument, format, args...).

func IsAborted

func IsAborted(err error) bool

IsAborted returns true if FromError(err).Code() == CodeAborted.

func IsAlreadyExists

func IsAlreadyExists(err error) bool

IsAlreadyExists returns true if FromError(err).Code() == CodeAlreadyExists.

func IsCancelled

func IsCancelled(err error) bool

IsCancelled returns true if FromError(err).Code() == CodeCancelled.

func IsDataLoss

func IsDataLoss(err error) bool

IsDataLoss returns true if FromError(err).Code() == CodeDataLoss.

func IsDeadlineExceeded

func IsDeadlineExceeded(err error) bool

IsDeadlineExceeded returns true if FromError(err).Code() == CodeDeadlineExceeded.

func IsFailedPrecondition

func IsFailedPrecondition(err error) bool

IsFailedPrecondition returns true if FromError(err).Code() == CodeFailedPrecondition.

func IsInternal

func IsInternal(err error) bool

IsInternal returns true if FromError(err).Code() == CodeInternal.

func IsInvalidArgument

func IsInvalidArgument(err error) bool

IsInvalidArgument returns true if FromError(err).Code() == CodeInvalidArgument.

func IsNotFound

func IsNotFound(err error) bool

IsNotFound returns true if FromError(err).Code() == CodeNotFound.

func IsOutOfRange

func IsOutOfRange(err error) bool

IsOutOfRange returns true if FromError(err).Code() == CodeOutOfRange.

func IsPermissionDenied

func IsPermissionDenied(err error) bool

IsPermissionDenied returns true if FromError(err).Code() == CodePermissionDenied.

func IsResourceExhausted

func IsResourceExhausted(err error) bool

IsResourceExhausted returns true if FromError(err).Code() == CodeResourceExhausted.

func IsStatus added in v1.17.0

func IsStatus(err error) bool

IsStatus returns whether the provided error is a YARPC error, or has a YARPCError() function to represent the error as a YARPC error. This includes wrapped errors.

This is false if the error is nil.

func IsUnauthenticated

func IsUnauthenticated(err error) bool

IsUnauthenticated returns true if FromError(err).Code() == CodeUnauthenticated.

func IsUnavailable

func IsUnavailable(err error) bool

IsUnavailable returns true if FromError(err).Code() == CodeUnavailable.

func IsUnimplemented

func IsUnimplemented(err error) bool

IsUnimplemented returns true if FromError(err).Code() == CodeUnimplemented.

func IsUnknown

func IsUnknown(err error) bool

IsUnknown returns true if FromError(err).Code() == CodeUnknown.

func IsYARPCError deprecated

This function has been deprecated.
func IsYARPCError(err error) bool

IsYARPCError returns whether the provided error is a YARPC error.

This is always false if the error is nil.

Deprecated: use IsStatus instead.

func NamedErrorf deprecated

This function has been deprecated.
func NamedErrorf(name string, format string, args ...interface{}) error

NamedErrorf returns a new Status with code CodeUnknown and the given name.

This should be used for user-defined errors.

The name must only contain lowercase letters from a-z and dashes (-), and cannot start or end in a dash. If the name is something else, an error with code CodeInternal will be returned.

Deprecated: Use Newf and WithName instead.

func NotFoundErrorf

func NotFoundErrorf(format string, args ...interface{}) error

NotFoundErrorf returns a new Status with code CodeNotFound by calling Newf(CodeNotFound, format, args...).

func OutOfRangeErrorf

func OutOfRangeErrorf(format string, args ...interface{}) error

OutOfRangeErrorf returns a new Status with code CodeOutOfRange by calling Newf(CodeOutOfRange, format, args...).

func PermissionDeniedErrorf

func PermissionDeniedErrorf(format string, args ...interface{}) error

PermissionDeniedErrorf returns a new Status with code CodePermissionDenied by calling Newf(CodePermissionDenied, format, args...).

func ResourceExhaustedErrorf

func ResourceExhaustedErrorf(format string, args ...interface{}) error

ResourceExhaustedErrorf returns a new Status with code CodeResourceExhausted by calling Newf(CodeResourceExhausted, format, args...).

func UnauthenticatedErrorf

func UnauthenticatedErrorf(format string, args ...interface{}) error

UnauthenticatedErrorf returns a new Status with code CodeUnauthenticated by calling Newf(CodeUnauthenticated, format, args...).

func UnavailableErrorf

func UnavailableErrorf(format string, args ...interface{}) error

UnavailableErrorf returns a new Status with code CodeUnavailable by calling Newf(CodeUnavailable, format, args...).

func UnimplementedErrorf

func UnimplementedErrorf(format string, args ...interface{}) error

UnimplementedErrorf returns a new Status with code CodeUnimplemented by calling Newf(CodeUnimplemented, format, args...).

func UnknownErrorf

func UnknownErrorf(format string, args ...interface{}) error

UnknownErrorf returns a new Status with code CodeUnknown by calling Newf(CodeUnknown, format, args...).

Types

type Code

type Code int

Code represents the type of error for an RPC call.

Sometimes multiple error codes may apply. Services should return the most specific error code that applies. For example, prefer `OutOfRange` over `FailedPrecondition` if both codes apply. Similarly prefer `NotFound` or `AlreadyExists` over `FailedPrecondition`.

These codes are meant to match gRPC status codes. https://godoc.org/google.golang.org/grpc/codes#Code

const (
	// CodeOK means no error; returned on success
	CodeOK Code = 0

	// CodeCancelled means the operation was cancelled, typically by the caller.
	// This is considered as a client error.
	CodeCancelled Code = 1

	// CodeUnknown means an unknown error. Errors raised by APIs
	// that do not return enough error information
	// may be converted to this error.
	// This is considered as a server error.
	CodeUnknown Code = 2

	// CodeInvalidArgument means the client specified an invalid argument.
	// Note that this differs from `FailedPrecondition`. `InvalidArgument`
	// indicates arguments that are problematic regardless of the state of
	// the system (e.g., a malformed file name).
	// This is considered as a client error.
	CodeInvalidArgument Code = 3

	// CodeDeadlineExceeded means the deadline expired before the operation could
	// complete. 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.
	// This is considered as a server error.
	CodeDeadlineExceeded Code = 4

	// CodeNotFound means some requested entity (e.g., file or directory) was not found.
	// For privacy reasons, this code *may* be returned when the client
	// does not have the access rights to the entity, though such usage is
	// discouraged.
	// This is considered as a client error.
	CodeNotFound Code = 5

	// CodeAlreadyExists means the entity that a client attempted to create
	// (e.g., file or directory) already exists.
	// This is considered as a client error.
	CodeAlreadyExists Code = 6

	// CodePermissionDenied means the caller does not have permission to execute
	// the specified operation. `PermissionDenied` must not be used for rejections
	// caused by exhausting some resource (use `ResourceExhausted`
	// instead for those errors). `PermissionDenied` must not be
	// used if the caller can not be identified (use `Unauthenticated`
	// instead for those errors).
	// This is considered as a client error.
	CodePermissionDenied Code = 7

	// CodeResourceExhausted means some resource has been exhausted, perhaps a per-user
	// quota, or perhaps the entire file system is out of space.
	// This is considered as a client error.
	CodeResourceExhausted Code = 8

	// CodeFailedPrecondition means the operation was rejected because the system is not
	// in a state required for the operation's execution. For example, the directory
	// to be deleted is non-empty, an rmdir operation is applied to
	// a non-directory, etc.
	//
	// Service implementors can use the following guidelines to decide
	// 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
	//      the files are deleted from the directory.
	// This is considered as a client error.
	CodeFailedPrecondition Code = 9

	// CodeAborted means the operation was aborted, typically due to a concurrency issue
	// such as a sequencer check failure or transaction abort.
	//
	// See the guidelines above for deciding between `FailedPrecondition`,
	// `Aborted`, and `Unavailable`.
	// This is considered as a client error.
	CodeAborted Code = 10

	// CodeOutOfRange means the 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.
	// This is considered as a client error.
	CodeOutOfRange Code = 11

	// CodeUnimplemented means the operation is not implemented or is not
	// supported/enabled in this service.
	// This is considered as a client error.
	CodeUnimplemented Code = 12

	// CodeInternal means an internal error. This means that some invariants expected
	// by the underlying system have been broken. This error code is reserved
	// for serious errors.
	// This is considered as a server error.
	CodeInternal Code = 13

	// CodeUnavailable means the service is currently unavailable. This is most likely a
	// transient condition, which can be corrected by retrying with a backoff.
	//
	// See the guidelines above for deciding between `FailedPrecondition`,
	// `Aborted`, and `Unavailable`.
	// This is considered as a server error.
	CodeUnavailable Code = 14

	// CodeDataLoss means unrecoverable data loss or corruption.
	// This is considered as a server error.
	CodeDataLoss Code = 15

	// CodeUnauthenticated means the request does not have valid authentication
	// credentials for the operation.
	// This is considered as a client error.
	CodeUnauthenticated Code = 16
)

func ErrorCode deprecated

This function has been deprecated.
func ErrorCode(err error) Code

ErrorCode returns the Code for the given error, CodeOK if the error is nil, or CodeUnknown if the given error is not a YARPC error.

Deprecated: Use FromError and Code instead.

func (Code) MarshalJSON

func (c Code) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler.

func (Code) MarshalText

func (c Code) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler.

func (Code) String

func (c Code) String() string

String returns the the string representation of the Code.

func (*Code) UnmarshalJSON

func (c *Code) UnmarshalJSON(text []byte) error

UnmarshalJSON implements json.Unmarshaler.

func (*Code) UnmarshalText

func (c *Code) UnmarshalText(text []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

type Status added in v1.17.0

type Status struct {
	// contains filtered or unexported fields
}

Status represents a YARPC error.

func FromError added in v1.17.0

func FromError(err error) *Status

FromError returns the Status for the provided error.

If the error:

- is nil, return nil
- is a 'Status', return the 'Status'
- has a 'YARPCError() *Status' method, returns the 'Status'

Otherwise, return a wrapped error with code 'CodeUnknown'.

func Newf added in v1.17.0

func Newf(code Code, format string, args ...interface{}) *Status

Newf returns a new Status.

The Code should never be CodeOK, if it is, this will return nil.

func (*Status) Code added in v1.17.0

func (s *Status) Code() Code

Code returns the error code for this Status.

func (*Status) Details added in v1.39.0

func (s *Status) Details() []byte

Details returns the error details for this Status.

func (*Status) Error added in v1.17.0

func (s *Status) Error() string

Error implements the error interface.

func (*Status) Message added in v1.17.0

func (s *Status) Message() string

Message returns the error message for this Status.

func (*Status) Name added in v1.17.0

func (s *Status) Name() string

Name returns the name of the error for this Status.

This is an empty string for all built-in YARPC errors. It may be customized by using WithName.

func (*Status) Unwrap added in v1.45.0

func (s *Status) Unwrap() error

Unwrap supports errors.Unwrap.

See "errors" package documentation for details.

func (*Status) WithDetails added in v1.39.0

func (s *Status) WithDetails(details []byte) *Status

WithDetails returns a new status with the given details bytes.

func (*Status) WithName deprecated added in v1.17.0

This method has been deprecated.
func (s *Status) WithName(name string) *Status

WithName returns a new Status with the given name.

This should be used for user-defined errors.

Deprecated: Use only error codes to represent the type of the error.

Source Files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto
y or Y : Canonical URL