httpsrv

Documentation

Index

• func Api(h miruken.Handler, middleware ...Middleware) http.Handler
• func Dispatch(h miruken.Handler, handler Handler, middleware ...Middleware) http.Handler
• func DispatchFunc(h miruken.Handler, ...) http.Handler
• func DispatchTo[H Handler](h miruken.Handler, middleware ...Middleware) http.Handler
• func Feature(config ...func(*Installer)) miruken.Feature
• type ApiHandler
  • func (a *ApiHandler) Constructor(_ *struct{ args.Optional }, logger logr.Logger)
  • func (a *ApiHandler) ServeHTTP(w http.ResponseWriter, r *http.Request, h miruken.Handler)
• type Handler
• type HandlerFunc
  • func (f HandlerFunc) ServeHTTP(w http.ResponseWriter, r *http.Request, h miruken.Handler)
• type Installer
  • func (i *Installer) DependsOn() []miruken.Feature
  • func (i *Installer) Install(setup *miruken.SetupBuilder) error
• type Middleware
  • func Pipe(middleware ...Middleware) Middleware
• type MiddlewareAdapter
  • func (m MiddlewareAdapter) ServeHTTP(s Middleware, w http.ResponseWriter, r *http.Request, p Middleware, ...)
• type MiddlewareFunc
  • func (f MiddlewareFunc) ServeHTTP(s Middleware, w http.ResponseWriter, r *http.Request, m Middleware, ...)
• type StatusCodeMapper
  • func (s *StatusCodeMapper) AccessDenied(_ ..., _ *authorizes.AccessDeniedError, _ *struct{ args.Optional }, ...) int
  • func (s *StatusCodeMapper) JsonSyntax(_ ..., _ *json.SyntaxError) int
  • func (s *StatusCodeMapper) NotHandled(_ ..., _ *miruken.NotHandledError) int
  • func (s *StatusCodeMapper) UnknownTypeId(_ ..., _ *api.UnknownTypeIdError) int
  • func (s *StatusCodeMapper) Validation(_ ..., _ *validates.Outcome) int

Functions

func Api

func Api(
	h miruken.Handler,
	middleware ...Middleware,
) http.Handler

Api builds a http.Handler for accepting polymorphic api calls through a Middleware pipeline.

func Dispatch

func Dispatch(
	h miruken.Handler,
	handler Handler,
	middleware ...Middleware,
) http.Handler

Dispatch builds an enhanced http.Handler for processing requests through a Middleware pipeline and terminating at a Handler.

func DispatchFunc

func DispatchFunc(
	h miruken.Handler,
	handler func(http.ResponseWriter, *http.Request, miruken.Handler),
	middleware ...Middleware,
) http.Handler

DispatchFunc builds an enhanced http.Handler for processing requests through a Middleware pipeline and terminating at a handler function.

func DispatchTo

func DispatchTo[H Handler](
	h miruken.Handler,
	middleware ...Middleware,
) http.Handler

DispatchTo builds an enhanced http.Handler for processing requests through a Middleware pipeline and terminating at a typed Handler.

func Feature

func Feature(config ...func(*Installer)) miruken.Feature

Feature configures http server support

Types

type ApiHandler

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

ApiHandler is a http.Handler for processing api requests over http.

func (*ApiHandler) Constructor

func (a *ApiHandler) Constructor(
	_ *struct{ args.Optional }, logger logr.Logger,
)

func (*ApiHandler) ServeHTTP

func (a *ApiHandler) ServeHTTP(
	w http.ResponseWriter,
	r *http.Request,
	h miruken.Handler,
)

type Handler

type Handler interface {
	ServeHTTP(
		w http.ResponseWriter,
		r *http.Request,
		h miruken.Handler,
	)
}

Handler augments http.Handler to provide miruken.Handler composer.

type HandlerFunc

type HandlerFunc func(
	w http.ResponseWriter,
	r *http.Request,
	h miruken.Handler,
)

HandlerFunc promotes a function to Handler.

func (HandlerFunc) ServeHTTP

func (f HandlerFunc) ServeHTTP(
	w http.ResponseWriter,
	r *http.Request,
	h miruken.Handler,
)

type Installer

type Installer struct{}

Installer configures http server support

func (*Installer) DependsOn

func (i *Installer) DependsOn() []miruken.Feature

func (*Installer) Install

func (i *Installer) Install(setup *miruken.SetupBuilder) error

type Middleware

type Middleware interface {
	ServeHTTP(
		Middleware,
		http.ResponseWriter,
		*http.Request,
		Middleware,
		miruken.Handler,
		func(miruken.Handler),
	)
}

Middleware augments Handler to participate in a pipeline to support pre and post processing of requests.

func Pipe

func Pipe(middleware ...Middleware) Middleware

Pipe builds a Middleware chain for pre and post processing of requests.

type MiddlewareAdapter

type MiddlewareAdapter struct{}

MiddlewareAdapter is an adapter for implementing Middleware using late binding method resolution.

func (MiddlewareAdapter) ServeHTTP

func (m MiddlewareAdapter) ServeHTTP(
	s Middleware,
	w http.ResponseWriter,
	r *http.Request,
	p Middleware,
	h miruken.Handler,
	n func(miruken.Handler),
)

type MiddlewareFunc

type MiddlewareFunc func(
	s Middleware,
	w http.ResponseWriter,
	r *http.Request,
	m Middleware,
	h miruken.Handler,
	n func(miruken.Handler),
)

MiddlewareFunc promotes a function to Middleware.

func (MiddlewareFunc) ServeHTTP

func (f MiddlewareFunc) ServeHTTP(
	s Middleware,
	w http.ResponseWriter,
	r *http.Request,
	m Middleware,
	h miruken.Handler,
	n func(miruken.Handler),
)

type StatusCodeMapper

type StatusCodeMapper struct{}

StatusCodeMapper maps errors into a corresponding http status code.

func (*StatusCodeMapper) AccessDenied

func (s *StatusCodeMapper) AccessDenied(
	_ *struct {
		maps.It
		maps.Format `to:"http:status-code"`
	}, _ *authorizes.AccessDeniedError,
	_ *struct{ args.Optional }, subject security.Subject,
) int

func (*StatusCodeMapper) JsonSyntax

func (s *StatusCodeMapper) JsonSyntax(
	_ *struct {
		maps.It
		maps.Format `to:"http:status-code"`
	}, _ *json.SyntaxError,
) int

func (*StatusCodeMapper) NotHandled

func (s *StatusCodeMapper) NotHandled(
	_ *struct {
		maps.It
		maps.Format `to:"http:status-code"`
	}, _ *miruken.NotHandledError,
) int

func (*StatusCodeMapper) UnknownTypeId

func (s *StatusCodeMapper) UnknownTypeId(
	_ *struct {
		maps.It
		maps.Format `to:"http:status-code"`
	}, _ *api.UnknownTypeIdError,
) int

func (*StatusCodeMapper) Validation

func (s *StatusCodeMapper) Validation(
	_ *struct {
		maps.It
		maps.Format `to:"http:status-code"`
	}, _ *validates.Outcome,
) int