erring

Documentation

Index

• type ErrPrefix
  • func (p ErrPrefix) ErrorIf(err error) error
  • func (p ErrPrefix) ErrorMap(data []byte, err error) ([]byte, error)
  • func (p ErrPrefix) Errorf(format string, a ...any) error
  • func (p ErrPrefix) Sprintf(format string, a ...any) string
• type Error
  • func (e *Error) As(target any) bool
  • func (e *Error) CatchIf(err error) bool
  • func (e *Error) Error() string
  • func (e *Error) HasErrs() bool
  • func (e *Error) Is(target error) bool
  • func (e *Error) Unwrap() []error
• type RespondError

Types

type ErrPrefix

type ErrPrefix string

ErrPrefix is a string that can be used to prefix an error message.

func (ErrPrefix) ErrorIf

func (p ErrPrefix) ErrorIf(err error) error

ErrorIf returns a error with prefix if the error is not nil, otherwise it returns nil.

func (ErrPrefix) ErrorMap

func (p ErrPrefix) ErrorMap(data []byte, err error) ([]byte, error)

ErrorMap is used to unwrap result from a function that returns a byte slice and an error. If the error is not nil, it returns the error with prefix, otherwise it returns the byte slice.

func (ErrPrefix) Errorf

func (p ErrPrefix) Errorf(format string, a ...any) error

Errorf returns a error with prefix and given format and arguments.

func (ErrPrefix) Sprintf

func (p ErrPrefix) Sprintf(format string, a ...any) string

Sprintf returns a string with prefix and given format and arguments.

type Error

type Error struct {
	Code    int    `json:"code" cbor:"code"`
	Message string `json:"message" cbor:"message"`
	Data    any    `json:"data,omitempty" cbor:"data,omitempty"`
	// contains filtered or unexported fields
}

Error represents a error with more information, can be used as response error.

func (*Error) As

func (e *Error) As(target any) bool

As implements the errors.As interface.

func (*Error) CatchIf

func (e *Error) CatchIf(err error) bool

CatchIf catches the error and return true if the error is not nil.

func (*Error) Error

func (e *Error) Error() string

Error returns the full error information as a JSON string, used as error log.

func (*Error) HasErrs

func (e *Error) HasErrs() bool

HasErrs return true if the Error has underlying errors.

func (*Error) Is

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

Is implements the errors.As interface.

func (*Error) Unwrap

func (e *Error) Unwrap() []error

Unwrap implements the errors.Unwrap interface.

type RespondError

type RespondError struct {
	Err any `json:"error" cbor:"error"`
}

RespondError represents a response with error that can be sent to the client.