fault

README

go-http-fault

Go package providing a net/http handler for logging errors and rendering them to the browser using custom templates.

Documentation

Documentation is incomplete at this time.

Documentation

Overview

package fault provides a net/http handler for logging errors and rendering them to the browser using custom templates.

Index

• Constants
• func AssignError(req *http.Request, err error, status int) *http.Request
• func FaultHandler(l *log.Logger) (http.Handler, error)
• func RetrieveError(req *http.Request) (int, error)
• func TemplatedFaultHandler(l *log.Logger, t *template.Template) (http.Handler, error)
• type FaultError
• type FaultHandlerVars

Constants

const ErrorKey string = "github.com/sfomuseum/go-http-fault#error"

const StatusKey string = "github.com/sfomuseum/go-http-fault#status"

Functions

func AssignError

func AssignError(req *http.Request, err error, status int) *http.Request

func FaultHandler

func FaultHandler(l *log.Logger) (http.Handler, error)

func RetrieveError

func RetrieveError(req *http.Request) (int, error)

func TemplatedFaultHandler

func TemplatedFaultHandler(l *log.Logger, t *template.Template) (http.Handler, error)

Types

type FaultError

type FaultError interface {
	error
	// Public returns an `error` instance whose string value is considered safe for publishing in a public setting or context.
	Public() error
	// Private returns an `error` instance whose string value that may contain details not suitable for publishing in a public setting or context.
	Private() error
}

FaultError is an interface for providing custom public and private error messages.

type FaultHandlerVars

type FaultHandlerVars struct {
	Status int
	Error  error
}