verrors

package
v0.0.0-...-1671bb8 Latest Latest
Warning

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

 Go to latest Published: Feb 20, 2021 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Overview

copy from https://github.com/go-kratos/kratos/tree/v2/errors

copy from https://github.com/go-kratos/kratos/tree/v2/errors

Index

Constants

View Source 
const (
	// UnknownReason is unknown reason for error info.
	UnknownReason = ""
	// SupportPackageIsVersion1 this constant should not be referenced by any other code.
	SupportPackageIsVersion1 = true
)

Variables

View Source 
var File_errors_proto protoreflect.FileDescriptor

Functions

func Aborted 

func Aborted(reason, format string, a ...interface{}) error

Aborted The operation was aborted, typically due to a concurrency issue such as a sequencer check failure or transaction abort. HTTP Mapping: 409 Conflict

func AlreadyExists 

func AlreadyExists(reason, format string, a ...interface{}) error

AlreadyExists The entity that a client attempted to create (e.g., file or directory) already exists. HTTP Mapping: 409 Conflict

func Cancelled 

func Cancelled(reason, format string, a ...interface{}) error

Cancelled The operation was cancelled, typically by the caller. HTTP Mapping: 499 Client Closed Request

func DataLoss 

func DataLoss(reason, format string, a ...interface{}) error

DataLoss Unrecoverable data loss or corruption. HTTP Mapping: 500 Internal Server Error

func DeadlineExceeded 

func DeadlineExceeded(reason, format string, a ...interface{}) error

DeadlineExceeded The deadline expired before the operation could complete. HTTP Mapping: 504 Gateway Timeout

func Error 

func Error(code int32, message string, details ...proto.Message) error

Error returns a Status representing c and msg.

func Errorf 

func Errorf(code int32, format string, a ...interface{}) error

Errorf returns New(c, fmt.Sprintf(format, a...)).

func FailedPrecondition 

func FailedPrecondition(reason, format string, a ...interface{}) error

FailedPrecondition The operation was rejected because the system is not in a state required for the operation's execution. HTTP Mapping: 400 Bad Request

func Internal 

func Internal(reason, format string, a ...interface{}) error

Internal This means that some invariants expected by the underlying system have been broken. This error code is reserved for serious errors.

HTTP Mapping: 500 Internal Server Error

func InvalidArgument 

func InvalidArgument(reason, format string, a ...interface{}) error

InvalidArgument The client specified an invalid argument. HTTP Mapping: 400 Bad Request

func IsAborted 

func IsAborted(err error) bool

func IsAlreadyExists 

func IsAlreadyExists(err error) bool

func IsCancelled 

func IsCancelled(err error) bool

func IsDataLoss 

func IsDataLoss(err error) bool

func IsDeadlineExceeded 

func IsDeadlineExceeded(err error) bool

func IsFailedPrecondition 

func IsFailedPrecondition(err error) bool

func IsInternal 

func IsInternal(err error) bool

func IsInvalidArgument 

func IsInvalidArgument(err error) bool

func IsNotFound 

func IsNotFound(err error) bool

func IsOutOfRange 

func IsOutOfRange(err error) bool

func IsPermissionDenied 

func IsPermissionDenied(err error) bool

func IsResourceExhausted 

func IsResourceExhausted(err error) bool

func IsUnauthorized 

func IsUnauthorized(err error) bool

func IsUnavailable 

func IsUnavailable(err error) bool

func IsUnimplemented 

func IsUnimplemented(err error) bool

func IsUnknown 

func IsUnknown(err error) bool

func NotFound 

func NotFound(reason, format string, a ...interface{}) error

NotFound Some requested entity (e.g., file or directory) was not found. HTTP Mapping: 404 Not Found

func OutOfRange 

func OutOfRange(reason, format string, a ...interface{}) error

OutOfRange The operation was attempted past the valid range. E.g., seeking or reading past end-of-file. HTTP Mapping: 400 Bad Request

func PermissionDenied 

func PermissionDenied(reason, format string, a ...interface{}) error

PermissionDenied The caller does not have permission to execute the specified operation. HTTP Mapping: 403 Forbidden

func ResourceExhausted 

func ResourceExhausted(reason, format string, a ...interface{}) error

ResourceExhausted Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space. HTTP Mapping: 429 Too Many Requests

func Unauthorized 

func Unauthorized(reason, format string, a ...interface{}) error

Unauthorized The request does not have valid authentication credentials for the operation. HTTP Mapping: 401 Unauthorized

func Unavailable 

func Unavailable(reason, format string, a ...interface{}) error

Unavailable The service is currently unavailable. HTTP Mapping: 503 Service Unavailable

func Unimplemented 

func Unimplemented(reason, format string, a ...interface{}) error

Unimplemented The operation is not implemented or is not supported/enabled in this service. HTTP Mapping: 501 Not Implemented

func Unknown 

func Unknown(reason, format string, a ...interface{}) error

Unknown error. HTTP Mapping: 500 Internal Server Error

Types

type ErrorItem 

type ErrorItem struct {

	// Reason is the typed error code. For example: "some_example".
	Reason string `protobuf:"bytes,1,opt,name=reason,proto3" json:"reason,omitempty"`
	// Message is the human-readable description of the error.
	Message string `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"`
	// contains filtered or unexported fields
}

ErrorItem is a detailed error code & message from the API frontend.

func Reason 

func Reason(err error) *ErrorItem

Reason returns the gRPC status for a particular error. It supports wrapped errors.

func (*ErrorItem) Descriptor deprecated 

func (*ErrorItem) Descriptor() ([]byte, []int)

Deprecated: Use ErrorItem.ProtoReflect.Descriptor instead.

func (*ErrorItem) GetMessage 

func (x *ErrorItem) GetMessage() string

func (*ErrorItem) GetReason 

func (x *ErrorItem) GetReason() string

func (*ErrorItem) ProtoMessage 

func (*ErrorItem) ProtoMessage()

func (*ErrorItem) ProtoReflect 

func (x *ErrorItem) ProtoReflect() protoreflect.Message

func (*ErrorItem) Reset 

func (x *ErrorItem) Reset()

func (*ErrorItem) String 

func (x *ErrorItem) String() string

type StatusError 

type StatusError struct {
	// Code is the gRPC response status code and will always be populated.
	Code int32 `json:"code"`
	// Message is the server response message and is only populated when
	// explicitly referenced by the JSON server response.
	Message string `json:"message"`
	// Details provide more context to an error.
	Details []proto.Message `json:"details"`
}

StatusError contains an error response from the server.

func (*StatusError) Error 

func (e *StatusError) Error() string

func (*StatusError) Is 

func (e *StatusError) Is(target error) bool

Is matches each error in the chain with the target value.

func (*StatusError) WithDetails 

func (e *StatusError) WithDetails(details ...proto.Message)

WithDetails provided details messages appended to the errors.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.