errors

Documentation

Index

• func IsErrorWithCode(err error, code Code) bool
• type Code
• type Error
  • func NewError(message string, code Code) *Error
  • func NewPublicError(publicMessage string, code Code) *Error
  • func (e *Error) Error() string
  • func (e *Error) Unwrap() error
  • func (e *Error) WithData(data any) *Error
  • func (e *Error) WithPublicMessage(msg string) *Error
  • func (e *Error) Wrap(err error) *Error
• type ResponseError
  • func AsResponseError(obj any) (*ResponseError, bool)
  • func (e *ResponseError) Error() string

Functions

func IsErrorWithCode

func IsErrorWithCode(err error, code Code) bool

Types

type Code

type Code string

Code is useful for converting to HTTP status code. In general it's a value which is machine readable.

type Error

type Error struct {
	Err           error
	Message       string
	PublicMessage string
	Code          Code
	Data          any
}

Error represents API error. All fields (except of wrapped error and message) are meant to be publicly sharable.

func NewError

func NewError(message string, code Code) *Error

func NewPublicError

func NewPublicError(publicMessage string, code Code) *Error

func (*Error) Error

func (e *Error) Error() string

func (*Error) Unwrap

func (e *Error) Unwrap() error

func (*Error) WithData

func (e *Error) WithData(data any) *Error

func (*Error) WithPublicMessage

func (e *Error) WithPublicMessage(msg string) *Error

func (*Error) Wrap

func (e *Error) Wrap(err error) *Error

type ResponseError

type ResponseError struct {
	model.BaseResponse

	// An HTTP status code for unsuccessful requests.
	StatusCode int
}

ResponseError represents an API response with an error status code.

func AsResponseError

func AsResponseError(obj any) (*ResponseError, bool)

func (*ResponseError) Error

func (e *ResponseError) Error() string

Error returns the details of an error response.