http

Documentation

Index

• Constants
• Variables
• func NewRuntimeServeMux() *runtime.ServeMux
• func NewStandardServeMux() *http.ServeMux
• type Config
• type Errorer
• type Handle
• type Handler
  • func NewHandler[Req any, Res any](mux ServeMux, mar *marshaller.Map, err Errorer[Res]) *Handler[Req, Res]
  • func (s *Handler[Req, Res]) Handle(verb, pattern string, fn Handle[Req, Res]) error
• type MuxKind
• type RuntimeServeMux
  • func (r *RuntimeServeMux) Handle(verb, pattern string, fn http.HandlerFunc) error
  • func (r *RuntimeServeMux) Handler() http.Handler
• type ServeMux
  • func NewServeMux(kind MuxKind, r *runtime.ServeMux, s *http.ServeMux) ServeMux
• type Server
  • func NewServer(server *http.Server, cfg *Config) (*Server, error)
  • func (s *Server) IsEnabled() bool
  • func (s *Server) Serve() error
  • func (s *Server) Shutdown(ctx context.Context) error
  • func (s *Server) String() string
• type StandardServeMux
  • func (s *StandardServeMux) Handle(verb, pattern string, fn http.HandlerFunc) error
  • func (s *StandardServeMux) Handler() http.Handler

Constants

const (
	// StandardMux for HTTP.
	StandardMux = MuxKind("standard")

	// GatewayMux for HTTP.
	GatewayMux = MuxKind("gateway")
)

Variables

var (
	// ErrReadAll for HTTP.
	ErrReadAll = errors.New("invalid body read")

	// ErrUnmarshal for HTTP.
	ErrUnmarshal = errors.New("invalid unmarshal")

	// ErrHandle for HTTP.
	ErrHandle = errors.New("invalid handle")

	// ErrMarshal for HTTP.
	ErrMarshal = errors.New("invalid marshal")
)

Functions

func NewRuntimeServeMux

func NewRuntimeServeMux() *runtime.ServeMux

NewRuntimeServeMux for HTTP.

func NewStandardServeMux

func NewStandardServeMux() *http.ServeMux

NewServeMux for http.

Types

type Config

type Config struct {
	TLS  *tls.Config
	Port string
}

Config for HTTP.

type Errorer

type Errorer[Res any] interface {
	// Error for this handler.
	Error(ctx context.Context, err error) *Res

	// Status code from error.
	Status(err error) int
}

Errorer for HTTP.

type Handle

type Handle[Req any, Res any] func(context.Context, *Req) (*Res, error)

Handle func for request/response.

type Handler

type Handler[Req any, Res any] struct {
	// contains filtered or unexported fields
}

Handler for HTTP.

func NewHandler

func NewHandler[Req any, Res any](mux ServeMux, mar *marshaller.Map, err Errorer[Res]) *Handler[Req, Res]

NewHandler for HTTP.

func (*Handler[Req, Res]) Handle

func (s *Handler[Req, Res]) Handle(verb, pattern string, fn Handle[Req, Res]) error

Handle for HTTP.

type MuxKind

type MuxKind string

MuxKind for HTTP.

type RuntimeServeMux

type RuntimeServeMux struct {
	*runtime.ServeMux
}

RuntimeServeMux for HTTP.

func (*RuntimeServeMux) Handle

func (r *RuntimeServeMux) Handle(verb, pattern string, fn http.HandlerFunc) error

func (*RuntimeServeMux) Handler

func (r *RuntimeServeMux) Handler() http.Handler

type ServeMux

type ServeMux interface {
	// Handle a verb, pattern with the func.
	Handle(verb, pattern string, fn http.HandlerFunc) error

	// Handler from the mux.
	Handler() http.Handler
}

ServeMux for HTTP.

func NewServeMux

func NewServeMux(kind MuxKind, r *runtime.ServeMux, s *http.ServeMux) ServeMux

NewServeMux for HTTP.

type Server

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

Server for HTTP.

func NewServer

func NewServer(server *http.Server, cfg *Config) (*Server, error)

NewServer for HTTP.

func (*Server) IsEnabled

func (s *Server) IsEnabled() bool

IsEnabled for server.

func (*Server) Serve

func (s *Server) Serve() error

Serve the underlying server.

func (*Server) Shutdown

func (s *Server) Shutdown(ctx context.Context) error

Shutdown the underlying server.

func (*Server) String

func (s *Server) String() string

type StandardServeMux

type StandardServeMux struct {
	*http.ServeMux
}

StandardServeMux for HTTP.

func (*StandardServeMux) Handle

func (s *StandardServeMux) Handle(verb, pattern string, fn http.HandlerFunc) error

func (*StandardServeMux) Handler

func (s *StandardServeMux) Handler() http.Handler