http

Documentation

Index

• Variables
• func Code(err error) int
• func Error(code int, msg string) error
• func Handle[Req any, Res any](path string, handler Handler[Req, Res])
• func IsError(err error) bool
• func Register(mu *http.ServeMux, ma *marshaller.Map)
• type Client
  • func NewClient[Req any, Res any](client *http.Client, mar *marshaller.Map) *Client[Req, Res]
  • func (c *Client[Req, Res]) Call(ctx context.Context, url, contentType string, req *Req) (*Res, error)
• type Config
• type 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

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 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 Handle

func Handle[Req any, Res any](path string, handler Handler[Req, Res])

Handler for HTTP.

func IsError

func IsError(err error) bool

IsError verifies if the package created this error.

func Register

func Register(mu *http.ServeMux, ma *marshaller.Map)

Register for HTTP.

Types

type Client

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

Client for HTTP.

func NewClient

func NewClient[Req any, Res any](client *http.Client, mar *marshaller.Map) *Client[Req, Res]

NewClient for HTTP.

func (*Client[Req, Res]) Call

func (c *Client[Req, Res]) Call(ctx context.Context, url, contentType string, req *Req) (*Res, error)

Call 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.

type Handler

type Handler[Req any, Res any] interface {
	// Handle func for 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