mrserver

Documentation

Index

• Constants
• func MiddlewareGeneral(tr *mrlang.Translator, ...) func(next http.Handler) http.Handler
• func MiddlewareHandlerAdapter(s ErrorResponseSender) func(next HttpHandlerFunc) http.HandlerFunc
• func MiddlewareHandlerCheckAccess(handlerName string, access mrperms.AccessRightsFactory, ...) func(next HttpHandlerFunc) HttpHandlerFunc
• func MiddlewareHandlerIdempotency(provider mridempotency.Provider, sender ResponseSender) func(next HttpHandlerFunc) HttpHandlerFunc
• func MiddlewareRecoverHandler(isDebug bool, fatalFunc http.HandlerFunc) func(next http.Handler) http.Handler
• func PrepareAppToStart(ctx context.Context) (execute func() error, interrupt func(error))
• type CacheableResponseWriter
  • func NewCacheableResponseWriter(w http.ResponseWriter) *CacheableResponseWriter
  • func (w *CacheableResponseWriter) Body() []byte
  • func (w *CacheableResponseWriter) StatusCode() int
  • func (w *CacheableResponseWriter) Write(buf []byte) (int, error)
  • func (w *CacheableResponseWriter) WriteHeader(statusCode int)
• type ErrorResponseSender
• type ErrorStatusGetter
• type FileResponseSender
• type HttpController
• type HttpErrorStatusGetter
  • func NewHttpErrorStatusGetter(unexpectedStatus int) *HttpErrorStatusGetter
  • func (g *HttpErrorStatusGetter) ErrorStatus(err error) int
• type HttpHandler
• type HttpHandlerFunc
• type HttpRouter
• type ListenOptions
• type RequestDecoder
• type RequestParserBool
• type RequestParserDateTime
• type RequestParserFile
• type RequestParserImage
• type RequestParserInt64
• type RequestParserItemStatus
• type RequestParserKeyInt32
• type RequestParserListPager
• type RequestParserListSorter
• type RequestParserParamFunc
• type RequestParserString
• type RequestParserUUID
• type RequestParserValidate
• type ResponseEncoder
• type ResponseSender
• type ServerAdapter
  • func NewServerAdapter(ctx context.Context, opts ServerOptions) *ServerAdapter
  • func (s *ServerAdapter) PrepareToStart(ctx context.Context) (execute func() error, interrupt func(error))
  • func (s *ServerAdapter) Shutdown(ctx context.Context) error
  • func (s *ServerAdapter) Start(ctx context.Context) error
• type ServerOptions
• type StatRequest
  • func NewStatRequest(r *http.Request) *StatRequest
  • func (r *StatRequest) Bytes() int
  • func (r *StatRequest) Request() *http.Request
• type StatResponseWriter
  • func NewStatResponseWriter(w http.ResponseWriter, onWrite func(buf []byte)) *StatResponseWriter
  • func (w *StatResponseWriter) Bytes() int
  • func (w *StatResponseWriter) StatusCode() int
  • func (w *StatResponseWriter) Write(buf []byte) (int, error)
  • func (w *StatResponseWriter) WriteHeader(statusCode int)

Constants

const (
	VarRestOfURL = "{{restOfUrl}}" // VarRestOfURL - comment const
)

Functions

func MiddlewareGeneral

func MiddlewareGeneral(
	tr *mrlang.Translator,
	observeRequestFunc func(l mrlog.Logger, start time.Time, sr *StatRequest, sw *StatResponseWriter),
) func(next http.Handler) http.Handler

MiddlewareGeneral - comment func.

func MiddlewareHandlerAdapter

func MiddlewareHandlerAdapter(s ErrorResponseSender) func(next HttpHandlerFunc) http.HandlerFunc

MiddlewareHandlerAdapter - comment func.

func MiddlewareHandlerCheckAccess

func MiddlewareHandlerCheckAccess(
	handlerName string,
	access mrperms.AccessRightsFactory,
	privilege, permission string,
) func(next HttpHandlerFunc) HttpHandlerFunc

MiddlewareHandlerCheckAccess - comment func.

func MiddlewareHandlerIdempotency

func MiddlewareHandlerIdempotency(provider mridempotency.Provider, sender ResponseSender) func(next HttpHandlerFunc) HttpHandlerFunc

MiddlewareHandlerIdempotency - comment func.

func MiddlewareRecoverHandler

func MiddlewareRecoverHandler(isDebug bool, fatalFunc http.HandlerFunc) func(next http.Handler) http.Handler

MiddlewareRecoverHandler - comment func.

func PrepareAppToStart

func PrepareAppToStart(ctx context.Context) (execute func() error, interrupt func(error))

PrepareAppToStart - comment func.

Types

type CacheableResponseWriter

type CacheableResponseWriter struct {
	http.ResponseWriter
	// contains filtered or unexported fields
}

CacheableResponseWriter - comment struct.

func NewCacheableResponseWriter

func NewCacheableResponseWriter(w http.ResponseWriter) *CacheableResponseWriter

NewCacheableResponseWriter - создаёт объект CacheableResponseWriter.

func (*CacheableResponseWriter) Body

func (w *CacheableResponseWriter) Body() []byte

Body - comment method.

func (*CacheableResponseWriter) StatusCode

func (w *CacheableResponseWriter) StatusCode() int

StatusCode - comment method.

func (*CacheableResponseWriter) Write

func (w *CacheableResponseWriter) Write(buf []byte) (int, error)

Write - comment method.

func (*CacheableResponseWriter) WriteHeader

func (w *CacheableResponseWriter) WriteHeader(statusCode int)

WriteHeader - comment method.

type ErrorResponseSender

type ErrorResponseSender interface {
	SendError(w http.ResponseWriter, r *http.Request, err error)
}

ErrorResponseSender - отправляет ответ со списком ошибок полученных в результате обработки запроса.

type ErrorStatusGetter

type ErrorStatusGetter interface {
	ErrorStatus(err error) int
}

ErrorStatusGetter - возвращает http статус на основе указанной ошибки.

type FileResponseSender

type FileResponseSender interface {
	ResponseSender
	SendFile(ctx context.Context, w http.ResponseWriter, file mrtype.File) error
	SendAttachmentFile(ctx context.Context, w http.ResponseWriter, file mrtype.File) error
}

FileResponseSender - отправляет ответ с данными в виде файла сформированные сервером.

type HttpController

type HttpController interface {
	Handlers() []HttpHandler
}

HttpController - http контроллер со списком его обработчиков.

type HttpErrorStatusGetter

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

HttpErrorStatusGetter - only for: 401, 403, 404, 418, 5XX.

func NewHttpErrorStatusGetter

func NewHttpErrorStatusGetter(unexpectedStatus int) *HttpErrorStatusGetter

NewHttpErrorStatusGetter - создаёт объект HttpErrorStatusGetter.

func (*HttpErrorStatusGetter) ErrorStatus

func (g *HttpErrorStatusGetter) ErrorStatus(err error) int

ErrorStatus - comment method.

type HttpHandler

type HttpHandler struct {
	Method     string
	URL        string
	Permission string
	Func       HttpHandlerFunc
}

HttpHandler - http обработчик, к которому привязаны метод, URL и разрешение контролирующее запуск этого обработчика.

type HttpHandlerFunc

type HttpHandlerFunc func(w http.ResponseWriter, r *http.Request) error

HttpHandlerFunc - изменённый дизайн стандартного HTTP обработчика с возможностью возврата ошибки вместо её обработки в самом обработчике.

type HttpRouter

type HttpRouter interface {
	RegisterMiddleware(handlers ...func(next http.Handler) http.Handler)
	Register(controllers ...HttpController)
	HandlerFunc(method, path string, handler http.HandlerFunc)
	ServeHTTP(w http.ResponseWriter, r *http.Request)
}

HttpRouter - роутинг запросов с их регистрацией и запуском.

type ListenOptions

type ListenOptions struct {
	BindIP string
	Port   string
}

ListenOptions - опции для создания Listen.

type RequestDecoder

type RequestDecoder interface {
	ParseToStruct(ctx context.Context, content io.Reader, structPointer any) error
}

RequestDecoder - преобразователь данных в указанную go структуру.

type RequestParserBool

type RequestParserBool interface {
	FilterNullableBool(r *http.Request, key string) *bool
}

RequestParserBool - парсер данных запроса для преобразования их в *bool.

type RequestParserDateTime

type RequestParserDateTime interface {
	FilterDateTime(r *http.Request, key string) time.Time
}

RequestParserDateTime - парсер данных запроса для преобразования их в time.Time.

type RequestParserFile

type RequestParserFile interface {
	FormFile(r *http.Request, key string) (mrtype.File, error)
	FormFileContent(r *http.Request, key string) (mrtype.FileContent, error)
	FormFiles(r *http.Request, key string) ([]mrtype.FileHeader, error)
}

RequestParserFile - парсер данных запроса для преобразования их в файловую структуру.

type RequestParserImage

type RequestParserImage interface {
	FormImage(r *http.Request, key string) (mrtype.Image, error)
	FormImageContent(r *http.Request, key string) (mrtype.ImageContent, error)
	FormImages(r *http.Request, key string) ([]mrtype.ImageHeader, error)
}

RequestParserImage - парсер данных запроса для преобразования их в файловую структуру изображения.

type RequestParserInt64

type RequestParserInt64 interface {
	PathParamInt64(r *http.Request, name string) int64
	FilterInt64(r *http.Request, key string) int64
	FilterRangeInt64(r *http.Request, key string) mrtype.RangeInt64
	FilterInt64List(r *http.Request, key string) []int64
}

RequestParserInt64 - парсер данных запроса для преобразования их в int64.

type RequestParserItemStatus

type RequestParserItemStatus interface {
	FilterStatusList(r *http.Request, key string) []mrenum.ItemStatus
}

RequestParserItemStatus - парсер данных запроса для преобразования их в []mrenum.ItemStatus.

type RequestParserKeyInt32

type RequestParserKeyInt32 interface {
	PathKeyInt32(r *http.Request, name string) mrtype.KeyInt32
	FilterKeyInt32(r *http.Request, key string) mrtype.KeyInt32
	FilterKeyInt32List(r *http.Request, key string) []mrtype.KeyInt32
}

RequestParserKeyInt32 - парсер данных запроса для преобразования их в mrtype.KeyInt32.

type RequestParserListPager

type RequestParserListPager interface {
	PageParams(r *http.Request) mrtype.PageParams
}

RequestParserListPager - парсер данных запроса для преобразования их в mrtype.PageParams.

type RequestParserListSorter

type RequestParserListSorter interface {
	SortParams(r *http.Request, sorter mrview.ListSorter) mrtype.SortParams
}

RequestParserListSorter - парсер данных запроса для преобразования их в mrtype.SortParams.

type RequestParserParamFunc

type RequestParserParamFunc func(r *http.Request, key string) string

RequestParserParamFunc - функция для парсинга URL для извлечения из него параметров.

type RequestParserString

type RequestParserString interface {
	PathParamString(r *http.Request, name string) string
	RawParamString(r *http.Request, key string) *string // returns nil if the param not found
	FilterString(r *http.Request, key string) string
}

RequestParserString - парсер данных запроса для преобразования их в string.

type RequestParserUUID

type RequestParserUUID interface {
	PathParamUUID(r *http.Request, name string) uuid.UUID
	FilterUUID(r *http.Request, key string) uuid.UUID
}

RequestParserUUID - парсер данных запроса для преобразования их в uuid.UUID.

type RequestParserValidate

type RequestParserValidate interface {
	Validate(r *http.Request, structPointer any) error
	ValidateContent(ctx context.Context, content []byte, structPointer any) error
}

RequestParserValidate - парсер данных запроса для преобразования их в go структуру.

type ResponseEncoder

type ResponseEncoder interface {
	ContentType() string
	ContentTypeProblem() string
	Marshal(structure any) ([]byte, error)
}

ResponseEncoder - формирует ответ сервера из go структуры в необходимом формате.

type ResponseSender

type ResponseSender interface {
	Send(w http.ResponseWriter, status int, structure any) error
	SendBytes(w http.ResponseWriter, status int, body []byte) error
	SendNoContent(w http.ResponseWriter) error
}

ResponseSender - отправляет ответ с данными сформированные сервером.

type ServerAdapter

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

ServerAdapter - comment struct.

func NewServerAdapter

func NewServerAdapter(ctx context.Context, opts ServerOptions) *ServerAdapter

NewServerAdapter - создаёт объект ServerAdapter.

func (*ServerAdapter) PrepareToStart

func (s *ServerAdapter) PrepareToStart(ctx context.Context) (execute func() error, interrupt func(error))

PrepareToStart - comment method.

func (*ServerAdapter) Shutdown

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

Shutdown - comment method.

func (*ServerAdapter) Start

func (s *ServerAdapter) Start(ctx context.Context) error

Start - exec server Serve().

type ServerOptions

type ServerOptions struct {
	Caption         string
	Handler         http.Handler
	ReadTimeout     time.Duration
	WriteTimeout    time.Duration
	ShutdownTimeout time.Duration
	Listen          ListenOptions
}

ServerOptions - опции для создания Server.

type StatRequest

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

StatRequest - comment struct.

func NewStatRequest

func NewStatRequest(r *http.Request) *StatRequest

NewStatRequest - создаёт объект StatRequest. WARNING: the Body of the original http.Request will be replaced.

func (*StatRequest) Bytes

func (r *StatRequest) Bytes() int

Bytes - comment method.

func (*StatRequest) Request

func (r *StatRequest) Request() *http.Request

Request - comment method.

type StatResponseWriter

type StatResponseWriter struct {
	http.ResponseWriter
	// contains filtered or unexported fields
}

StatResponseWriter - comment struct.

func NewStatResponseWriter

func NewStatResponseWriter(w http.ResponseWriter, onWrite func(buf []byte)) *StatResponseWriter

NewStatResponseWriter - создаёт объект StatResponseWriter.

func (*StatResponseWriter) Bytes

func (w *StatResponseWriter) Bytes() int

Bytes - comment method.

func (*StatResponseWriter) StatusCode

func (w *StatResponseWriter) StatusCode() int

StatusCode - comment method.

func (*StatResponseWriter) Write

func (w *StatResponseWriter) Write(buf []byte) (int, error)

Write - comment method.

func (*StatResponseWriter) WriteHeader

func (w *StatResponseWriter) WriteHeader(statusCode int)

WriteHeader - comment method.