webhandlers

Documentation

Index

• Variables
• func Error(w http.ResponseWriter, r *http.Request, err error)
• func JSON(w http.ResponseWriter, r *http.Request, i any)
• func NewContextWithErrorValue(parent context.Context) (ctx context.Context, getError func() error)
• func NotFound(w http.ResponseWriter, r *http.Request)
• func ProcessError(in error) (statusCode int, err error)
• func RetrieveError(r *http.Request) error
• func WithErrorHandlers(h map[string]http.Handler) func(http.Handler) http.Handler
• type Data
• type ErrorTemplate
  • func NewErrorTemplate(t *template.Template) *ErrorTemplate
  • func (t *ErrorTemplate) ServeHTTP(w http.ResponseWriter, r *http.Request)

Variables

var Template = func() *ErrorTemplate {
	return NewErrorTemplate(template.Must(template.New("error").Parse(errorTemplate)))
}()

Template for rendering the static error.

Functions

func Error

func Error(w http.ResponseWriter, r *http.Request, err error)

Error writes the error to the response writer.

func JSON

func JSON(w http.ResponseWriter, r *http.Request, i any)

JSON encodes the provided message as JSON. When a marshalling error is encountered, Error is used in order to handle the error.

func NewContextWithErrorValue

func NewContextWithErrorValue(parent context.Context) (ctx context.Context, getError func() error)

NewContextWithErrorValue returns a context derived from parent and a func that returns any error stored by the Error handler.

func NotFound

func NotFound(w http.ResponseWriter, r *http.Request)

NotFound is the handler for routes that could not be found.

func ProcessError

func ProcessError(in error) (statusCode int, err error)

ProcessError processes an HTTP error by converting it if appropriate, and determining the HTTP status code to return.

func RetrieveError

func RetrieveError(r *http.Request) error

RetrieveError retrieves the error from the context.

func WithErrorHandlers

func WithErrorHandlers(h map[string]http.Handler) func(http.Handler) http.Handler

WithErrorHandlers registers additional error handlers to be used while rendering errors.

Types

type Data

type Data struct {
	ErrorTitle          string
	ErrorMessage        string
	ErrorID             string
	CorrelationID       string
	BackendErrorDetails string
	Year                int
	IsGenericNotFound   bool
}

Data contains data to render templates.

type ErrorTemplate

type ErrorTemplate struct {
	// contains filtered or unexported fields
}

ErrorTemplate wraps the error template for the static error route.

func NewErrorTemplate

func NewErrorTemplate(t *template.Template) *ErrorTemplate

NewErrorTemplate instantiates a new error template for non-frontend handled routes.

func (*ErrorTemplate) ServeHTTP

func (t *ErrorTemplate) ServeHTTP(w http.ResponseWriter, r *http.Request)

ServeHTTP renders the non-frontend handled errors.