httperror

package

v0.0.0-...-6d4bf48 Latest Latest Go to latest Published: Feb 3, 2023 License: AGPL-3.0 Imports: 7 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/Onyx-Protocol/Onyx

Links

Open Source Insights

Documentation ¶

Overview ¶

Package httperror defines the format for HTTP error responses from Chain services.

Index ¶

type Formatter
type Info
type Response
- func Parse(r io.Reader) (*Response, bool)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Formatter ¶

type Formatter struct {
	Default     Info
	IsTemporary func(info Info, err error) bool
	Errors      map[error]Info
}

Formatter defines rules for mapping errors to the Chain error response format.

func (Formatter) Format ¶

func (f Formatter) Format(err error) (body Response)

Format builds an error Response body describing err by consulting the f.Errors lookup table. If no entry is found, it returns f.Default.

func (Formatter) Log ¶

func (f Formatter) Log(ctx context.Context, err error)

Log writes a structured log entry to the chain/log logger with information about the error and the HTTP response.

func (Formatter) Write ¶

func (f Formatter) Write(ctx context.Context, w http.ResponseWriter, err error)

Write writes a json encoded Response to the ResponseWriter. It uses the status code associated with the error.

Write may be used as an ErrorWriter in the httpjson package.

type Info ¶

type Info struct {
	HTTPStatus int    `json:"-"`
	ChainCode  string `json:"code"`
	Message    string `json:"message"`
}

Info contains a set of error codes to send to the user.

type Response ¶

type Response struct {
	Info
	Detail    string                 `json:"detail,omitempty"`
	Data      map[string]interface{} `json:"data,omitempty"`
	Temporary bool                   `json:"temporary"`
}

Response defines the error response for a Chain error.

func Parse ¶

func Parse(r io.Reader) (*Response, bool)

Parse reads an error Response from the provided reader.

Source Files ¶

View all Source files

httperror.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL