akumu

Documentation

Index

• func DefaultResponderHandler(writer http.ResponseWriter, request *http.Request, builder Builder)
• func HandlerFunc(handler func(*http.Request) error) http.HandlerFunc
• func JSON[T any](reader io.Reader) (T, error)
• func Record(handler Handler, request *http.Request) *httptest.ResponseRecorder
• func RecordHandler(handler http.Handler, request *http.Request) *httptest.ResponseRecorder
• func RecordServer(server *http.Server, request *http.Request) *httptest.ResponseRecorder
• type Builder
  • func Failed(err error) Builder
  • func Response(status int) Builder
  • func (builder Builder) AppendHeader(key, value string) Builder
  • func (builder Builder) Body(body []byte) Builder
  • func (builder Builder) BodyReader(body io.Reader) Builder
  • func (builder Builder) BodyWriter(writer func(writer http.ResponseWriter)) Builder
  • func (builder Builder) Cookie(cookie http.Cookie) Builder
  • func (builder Builder) Error() string
  • func (builder Builder) Failed(err error) Builder
  • func (builder Builder) HTML(html string) Builder
  • func (builder Builder) Handle(response http.ResponseWriter, request *http.Request)
  • func (builder Builder) Handler(handler BuilderHandler) Builder
  • func (builder Builder) Header(key, value string) Builder
  • func (builder Builder) Headers(headers http.Header) Builder
  • func (builder Builder) JSON(body any) Builder
  • func (builder Builder) Merge(other Builder) Builder
  • func (builder Builder) Respond(request *http.Request) Builder
  • func (builder Builder) SSE(stream <-chan []byte) Builder
  • func (builder Builder) Status(status int) Builder
  • func (builder Builder) Stream(stream <-chan []byte) Builder
  • func (builder Builder) Text(body string) Builder
  • func (builder Builder) WithoutError() Builder
• type BuilderHandler
• type ContextKey
• type Contextual
  • func Context(request *http.Request) (*Contextual, bool)
  • func NewContext() *Contextual
  • func (ctx *Contextual) OnError(callback OnErrorCallback)
• type Handler
  • func (handler Handler) HandlerFunc() http.HandlerFunc
  • func (handler Handler) ServeHTTP(writer http.ResponseWriter, request *http.Request)
• type OnErrorCallback
• type OnErrorNext
• type Problem
  • func NewProblemFromError(err error, status int) Problem
  • func (problem Problem) Error() string
  • func (problem Problem) MarshalJSON() ([]byte, error)
  • func (problem Problem) Respond(request *http.Request) Builder
  • func (problem *Problem) UnmarshalJSON(data []byte) error
  • func (problem Problem) With(key string, value any) Problem
  • func (problem Problem) Without(key string) Problem
• type Responder
• type ServerError
  • func (err ServerError) Error() string
• type ServerErrorKind

Functions

func DefaultResponderHandler

func DefaultResponderHandler(writer http.ResponseWriter, request *http.Request, builder Builder)

func HandlerFunc

func HandlerFunc(handler func(*http.Request) error) http.HandlerFunc

func JSON

func JSON[T any](reader io.Reader) (T, error)

func Record

func Record(handler Handler, request *http.Request) *httptest.ResponseRecorder

func RecordHandler

func RecordHandler(handler http.Handler, request *http.Request) *httptest.ResponseRecorder

func RecordServer

func RecordServer(server *http.Server, request *http.Request) *httptest.ResponseRecorder

Types

type Builder

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

func Failed

func Failed(err error) Builder

func Response

func Response(status int) Builder

func (Builder) AppendHeader

func (builder Builder) AppendHeader(key, value string) Builder

func (Builder) Body

func (builder Builder) Body(body []byte) Builder

func (Builder) BodyReader

func (builder Builder) BodyReader(body io.Reader) Builder

func (Builder) BodyWriter

func (builder Builder) BodyWriter(writer func(writer http.ResponseWriter)) Builder

func (Builder) Cookie

func (builder Builder) Cookie(cookie http.Cookie) Builder

func (Builder) Error

func (builder Builder) Error() string

func (Builder) Failed

func (builder Builder) Failed(err error) Builder

func (Builder) HTML

func (builder Builder) HTML(html string) Builder

func (Builder) Handle

func (builder Builder) Handle(response http.ResponseWriter, request *http.Request)

func (Builder) Handler

func (builder Builder) Handler(handler BuilderHandler) Builder

func (Builder) Header

func (builder Builder) Header(key, value string) Builder

func (Builder) Headers

func (builder Builder) Headers(headers http.Header) Builder

func (Builder) JSON

func (builder Builder) JSON(body any) Builder

func (Builder) Merge

func (builder Builder) Merge(other Builder) Builder

func (Builder) Respond

func (builder Builder) Respond(request *http.Request) Builder

func (Builder) SSE

func (builder Builder) SSE(stream <-chan []byte) Builder

func (Builder) Status

func (builder Builder) Status(status int) Builder

func (Builder) Stream

func (builder Builder) Stream(stream <-chan []byte) Builder

func (Builder) Text

func (builder Builder) Text(body string) Builder

func (Builder) WithoutError

func (builder Builder) WithoutError() Builder

type BuilderHandler

type BuilderHandler func(http.ResponseWriter, *http.Request, Builder)

type ContextKey

type ContextKey struct{}

type Contextual

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

Contextual is a concurrent-safe implementation to append akumu-specific context to the given request.

func Context

func Context(request *http.Request) (*Contextual, bool)

func NewContext

func NewContext() *Contextual

func (*Contextual) OnError

func (ctx *Contextual) OnError(callback OnErrorCallback)

type Handler

type Handler func(*http.Request) error

func (Handler) HandlerFunc

func (handler Handler) HandlerFunc() http.HandlerFunc

func (Handler) ServeHTTP

func (handler Handler) ServeHTTP(writer http.ResponseWriter, request *http.Request)

type OnErrorCallback

type OnErrorCallback func(ServerError, OnErrorNext)

type OnErrorNext

type OnErrorNext func(ServerError)

type Problem

type Problem struct {
	Type     string
	Title    string
	Detail   string
	Status   int
	Instance string
	// contains filtered or unexported fields
}

Problem represents a problem details for HTTP APIs. See https://tools.ietf.org/html/rfc7807 for more information.

func NewProblemFromError

func NewProblemFromError(err error, status int) Problem

func (Problem) Error

func (problem Problem) Error() string

func (Problem) MarshalJSON

func (problem Problem) MarshalJSON() ([]byte, error)

func (Problem) Respond

func (problem Problem) Respond(request *http.Request) Builder

func (*Problem) UnmarshalJSON

func (problem *Problem) UnmarshalJSON(data []byte) error

func (Problem) With

func (problem Problem) With(key string, value any) Problem

func (Problem) Without

func (problem Problem) Without(key string) Problem

type Responder

type Responder interface {
	Respond(request *http.Request) Builder
}

type ServerError

type ServerError struct {
	Code int
	URL  string
	Text string
	Kind ServerErrorKind
	Body string
}

func (ServerError) Error

func (err ServerError) Error() string

type ServerErrorKind

type ServerErrorKind string

var (
	ServerErrorWriter  ServerErrorKind = "writer"
	ServerErrorBody    ServerErrorKind = "body"
	ServerErrorStream  ServerErrorKind = "stream"
	ServerErrorDefault ServerErrorKind = "default"
)