httpsrv

Documentation

Index

• Constants
• func Api(ctx *context.Context, middleware ...any) http.Handler
• func Feature(config ...func(*Installer)) setup.Feature
• func ListenAndServe(handler http.Handler, config *Config) error
• func New(handler http.Handler, config *Config) *http.Server
• func Use(ctx *context.Context, handler any, middleware ...any) http.Handler
• type Config
• type Handler
  • func H[H any](opts ...any) Handler
• type HandlerFunc
  • func (f HandlerFunc) ServeHTTP(w http.ResponseWriter, r *http.Request, h miruken.Handler)
• type Installer
  • func (i *Installer) DependsOn() []setup.Feature
  • func (i *Installer) Install(b *setup.Builder) error
• type Middleware
  • func M[M any](opts ...any) Middleware
  • func Pipe(middleware ...any) Middleware
• type MiddlewareFunc
  • func (f MiddlewareFunc) ServeHTTP(w http.ResponseWriter, r *http.Request, h miruken.Handler, ...)
• type PolyHandler
  • func (a *PolyHandler) Constructor(_ *struct{ args.Optional }, logger logr.Logger)
  • func (a *PolyHandler) ServeHTTP(w http.ResponseWriter, r *http.Request, h miruken.Handler)
• 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

Constants

const ComposerKey contextKey = 0

ComposerKey is used to access the miruken.Handler from the context.

Functions

func Api

func Api(
	ctx *context.Context,
	middleware ...any,
) http.Handler

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

func Feature

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

Feature configures http server support

func ListenAndServe

func ListenAndServe(
	handler http.Handler,
	config *Config,
) error

ListenAndServe creates and starts a http.Server with the provided configuration.

func New

func New(
	handler http.Handler,
	config *Config,
) *http.Server

New creates a new http.Server with the provided configuration.

func Use

func Use(
	ctx *context.Context,
	handler any,
	middleware ...any,
) http.Handler

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

Types

type Config

type Config struct {
	Addr              string
	ReadTimeout       time.Duration
	ReadHeaderTimeout time.Duration
	WriteTimeout      time.Duration
	IdleTimeout       time.Duration
	MaxHeaderBytes    int
}

Config provides http.Server configuration.

type Handler

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

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

func H

func H[H any](opts ...any) Handler

H builds a typed Handler wrapper for dynamic http processing.

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() []setup.Feature

func (*Installer) Install

func (i *Installer) Install(b *setup.Builder) error

type Middleware

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

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

func M

func M[M any](opts ...any) Middleware

M builds a typed Middleware wrapper for dynamic http processing.

func Pipe

func Pipe(middleware ...any) Middleware

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

type MiddlewareFunc

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

MiddlewareFunc promotes a function to Middleware.

func (MiddlewareFunc) ServeHTTP

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

type PolyHandler

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

PolyHandler is a Handler for processing polymorphic http requests.

func (*PolyHandler) Constructor

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

func (*PolyHandler) ServeHTTP

func (a *PolyHandler) ServeHTTP(
	w http.ResponseWriter,
	r *http.Request,
	h 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