Documentation
¶
Index ¶
- func EmptyResponseEncoder[Response any](statusCode int) httptransport.ResponseEncoder[Response]
- func ErrorEncoder(ctx context.Context, _ error, w http.ResponseWriter) bool
- func HandleErrorIfTypeMatches[T error](ctx context.Context, statusCode int, err error, w http.ResponseWriter, ...) bool
- func JSONRequestBodyDecoder(r *http.Request, out any) error
- func JSONResponseEncoder[Response any](_ context.Context, w http.ResponseWriter, response Response) error
- func JSONResponseEncoderWithStatus[Response any](statusCode int) httptransport.ResponseEncoder[Response]
- func PlainTextResponseEncoder[Response string](_ context.Context, w http.ResponseWriter, response Response) error
- type ErrorWithHTTPStatusCode
- type ExtendProblemFunc
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func EmptyResponseEncoder ¶
func EmptyResponseEncoder[Response any](statusCode int) httptransport.ResponseEncoder[Response]
func ErrorEncoder ¶
ErrorEncoder encodes an error as HTTP 500 Internal Server Error.
func HandleErrorIfTypeMatches ¶
func HandleErrorIfTypeMatches[T error](ctx context.Context, statusCode int, err error, w http.ResponseWriter, extendedProblemFunc ...func(T) (string, string)) bool
HandleErrorIfTypeMatches checks if the error is of the given type and encodes it as an HTTP error. Using the generic feature we can mandate that the error implements the error interface. This is a must, as the errors.As would panic if the error does not implement the error interface.
func JSONResponseEncoder ¶
func JSONResponseEncoder[Response any](_ context.Context, w http.ResponseWriter, response Response) error
JSONResponseEncoder encodes a response as JSON.
func JSONResponseEncoderWithStatus ¶
func JSONResponseEncoderWithStatus[Response any](statusCode int) httptransport.ResponseEncoder[Response]
func PlainTextResponseEncoder ¶
func PlainTextResponseEncoder[Response string](_ context.Context, w http.ResponseWriter, response Response) error
PlainTextResponseEncoder encodes a response as PlainText.
Types ¶
type ErrorWithHTTPStatusCode ¶
type ErrorWithHTTPStatusCode struct {
StatusCode int
Extensions []ExtendProblemFunc
// contains filtered or unexported fields
}
func NewHTTPError ¶
func NewHTTPError(statusCode int, err error, extensions ...ExtendProblemFunc) ErrorWithHTTPStatusCode
func (ErrorWithHTTPStatusCode) EncodeError ¶
func (e ErrorWithHTTPStatusCode) EncodeError(ctx context.Context, w http.ResponseWriter) bool
type ExtendProblemFunc ¶
func ExtendProblem ¶
func ExtendProblem(name, details string) ExtendProblemFunc
Source Files
Click to show internal directories.
Click to hide internal directories.