http

Documentation

Index

• func Code(err error) int
• func Error(code int, msg string) error
• func IsError(err error) bool
• func Transport(cfg *tls.Config) http.RoundTripper
• func WriteError(ctx Context, err error)
• type Client
• type Config
• type Context
  • func NewContext(ctx context.Context, req *http.Request, res http.ResponseWriter) Context
• type Handler
• 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

Functions

func Code

func Code(err error) int

Code from the error, otherwise 500.

func Error

func Error(code int, msg string) error

Error representing code and msg.

func IsError

func IsError(err error) bool

IsError verifies if the package created this error.

func Transport

func Transport(cfg *tls.Config) http.RoundTripper

Transport for HTTP.

func WriteError

func WriteError(ctx Context, err error)

WriteError for HTTP.

Types

type Client

type Client[Req any, Res any] interface {
	// Call with request.
	Call(ctx context.Context, req *Req) (*Res, error)
}

Client for HTTP.

type Config

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

Config for HTTP.

type Context

type Context interface {
	// Request of the context.
	Request() *http.Request

	// Response of the context.
	Response() http.ResponseWriter

	context.Context
}

Context for HTTP.

func NewContext

func NewContext(ctx context.Context, req *http.Request, res http.ResponseWriter) Context

NewContext for HTTP.

type Handler

type Handler[Req any, Res any] interface {
	// Handle the request/response.
	Handle(ctx Context, req *Req) (*Res, error)
}

Handler 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