handler

Documentation

Overview

Copyright (c) 2016-2019 Uber Technologies, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• func Wrap(h ErrHandler) http.HandlerFunc
• type ErrHandler
• type Error
  • func ErrorStatus(s int) *Error
  • func Errorf(format string, args ...interface{}) *Error
  • func (e *Error) Error() string
  • func (e *Error) GetStatus() int
  • func (e *Error) Header(k, v string) *Error
  • func (e *Error) Status(s int) *Error

Functions

func Wrap

func Wrap(h ErrHandler) http.HandlerFunc

Wrap converts an ErrHandler into an http.HandlerFunc by handling the error returned by h.

Types

type ErrHandler

type ErrHandler func(http.ResponseWriter, *http.Request) error

ErrHandler defines an HTTP handler which returns an error.

type Error

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

Error defines an HTTP handler error which encapsulates status and headers to be set in the HTTP response.

func ErrorStatus

func ErrorStatus(s int) *Error

ErrorStatus creates an empty message error with status s.

func Errorf

func Errorf(format string, args ...interface{}) *Error

Errorf creates a new Error with Printf-style formatting. Defaults to 500 error.

func (*Error) Error

func (e *Error) Error() string

func (*Error) GetStatus

func (e *Error) GetStatus() int

GetStatus returns the error status.

func (*Error) Header

func (e *Error) Header(k, v string) *Error

Header adds a custom header to e.

func (*Error) Status

func (e *Error) Status(s int) *Error

Status sets a custom status on e.