errors

Documentation

Overview

Package errors provide an error type with code.

Index

• type E
  • func Internal(err error) *E
  • func InvalidInput(field string) *E
  • func (e *E) As(target interface{}) bool
  • func (e *E) Error() string
  • func (e *E) Unwrap() error

Types

type E

type E struct {
	Code    int    `json:"code,omitempty"`
	Message string `json:"message,omitempty"`
	Name    string `json:"name,omitempty"`
	// contains filtered or unexported fields
}

E define custom error that wrap underlying error with custom code, message, and name.

The Code field is required, used to communicate the HTTP response code. The Message field is optional, it's used to communicate the actual error message from server, to be readable by human. The Name field is optional, intended to be consumed by program, for example, to provide a key as translation of Message into user's locale defined language.

func Internal

func Internal(err error) *E

Internal define an error caused by server.

func InvalidInput

func InvalidInput(field string) *E

InvalidInput generate an error for invalid input.

func (*E) As

func (e *E) As(target interface{}) bool

As set the target to e only if only target is **E.

func (*E) Error

func (e *E) Error() string

Error implement the error interface.

func (*E) Unwrap

func (e *E) Unwrap() error

Unwrap return the internal error.