courierhttp

Documentation

Overview

+gengo:runtimedoc=false

Package courierhttp GENERATED BY gengo:injectable DON'T EDIT THIS FILE

Index

• func BasePath(basePath string) courier.Operator
• func BasePathRouter(basePath string) courier.Router
• func Group(path string) courier.Operator
• func GroupRouter(path string) courier.Router
• func OperationInfoInjectContext(ctx context.Context, tpe *OperationInfo) context.Context
• func RequestInjectContext(ctx context.Context, tpe *Request) context.Context
• func RouteDescriberInjectContext(ctx context.Context, tpe RouteDescriber) context.Context
• type BasePathDescriber
• type ContentTypeDescriber
• type CookiesDescriber
• type ErrContextCanceled
  • func (e *ErrContextCanceled) Error() string
  • func (e *ErrContextCanceled) StatusCode() int
• type ErrResponseWriter
• type ErrorResponse
  • func WrapError(err error, opts ...ResponseSettingFunc) ErrorResponse
• type FileHeader
• type Method
• type MethodConnect
  • func (MethodConnect) Method() string
• type MethodDelete
  • func (MethodDelete) Method() string
• type MethodDescriber
• type MethodGet
  • func (MethodGet) Method() string
• type MethodHead
  • func (MethodHead) Method() string
• type MethodOptions
  • func (MethodOptions) Method() string
• type MethodPatch
  • func (MethodPatch) Method() string
• type MethodPost
  • func (MethodPost) Method() string
• type MethodPut
  • func (MethodPut) Method() string
• type MethodTrace
  • func (MethodTrace) Method() string
• type NoContent
• type OperationInfo
  • func OperationInfoFromContext(ctx context.Context) (*OperationInfo, bool)
  • func (v *OperationInfo) Init(ctx context.Context) error
  • func (p *OperationInfo) InjectContext(ctx context.Context) context.Context
  • func (s OperationInfo) UserAgent() string
• type PathDescriber
• type RedirectDescriber
• type Request
  • func RequestFromContext(ctx context.Context) (*Request, bool)
• type RequestInfo
• type Response
  • func Redirect(statusCode int, location *url.URL) Response[any]
  • func Wrap[T any](v T, opts ...ResponseSettingFunc) Response[T]
• type ResponseSetting
• type ResponseSettingFunc
  • func WithContentType(contentType string) ResponseSettingFunc
  • func WithCookies(cookies ...*http.Cookie) ResponseSettingFunc
  • func WithMetadata(key string, values ...string) ResponseSettingFunc
  • func WithStatusCode(statusCode int) ResponseSettingFunc
• type ResponseWriter
• type RouteDescriber
  • func RouteDescriberFromContext(ctx context.Context) (RouteDescriber, bool)
• type Server
  • func (s Server) UserAgent() string
• type StatusCodeDescriber
• type WithHeader

Functions

func BasePath

func BasePath(basePath string) courier.Operator

func BasePathRouter

func BasePathRouter(basePath string) courier.Router

func Group

func Group(path string) courier.Operator

func GroupRouter

func GroupRouter(path string) courier.Router

func OperationInfoInjectContext

func OperationInfoInjectContext(ctx context.Context, tpe *OperationInfo) context.Context

func RequestInjectContext

func RequestInjectContext(ctx context.Context, tpe *Request) context.Context

func RouteDescriberInjectContext

func RouteDescriberInjectContext(ctx context.Context, tpe RouteDescriber) context.Context

Types

type BasePathDescriber

type BasePathDescriber interface {
	BasePath() string
}

type ContentTypeDescriber

type ContentTypeDescriber interface {
	ContentType() string
}

type CookiesDescriber

type CookiesDescriber interface {
	Cookies() []*http.Cookie
}

type ErrContextCanceled

type ErrContextCanceled struct {
	Reason string
}

func (*ErrContextCanceled) Error

func (e *ErrContextCanceled) Error() string

func (*ErrContextCanceled) StatusCode

func (e *ErrContextCanceled) StatusCode() int

type ErrResponseWriter

type ErrResponseWriter interface {
	WriteErr(ctx context.Context, rw http.ResponseWriter, req RequestInfo, err error)
}

type ErrorResponse

type ErrorResponse interface {
	Error() string
	Unwrap() error

	StatusCodeDescriber
	ContentTypeDescriber
	CookiesDescriber
	courier.MetadataCarrier
}

func WrapError

func WrapError(err error, opts ...ResponseSettingFunc) ErrorResponse

type FileHeader

type FileHeader interface {
	io.ReadCloser
	Filename() string
	Header() http.Header
}

type Method

type Method struct {
}

type MethodConnect

type MethodConnect struct{}

func (MethodConnect) Method

func (MethodConnect) Method() string

type MethodDelete

type MethodDelete struct{}

func (MethodDelete) Method

func (MethodDelete) Method() string

type MethodDescriber

type MethodDescriber interface {
	Method() string
}

type MethodGet

type MethodGet struct{}

func (MethodGet) Method

func (MethodGet) Method() string

type MethodHead

type MethodHead struct{}

func (MethodHead) Method

func (MethodHead) Method() string

type MethodOptions

type MethodOptions struct{}

func (MethodOptions) Method

func (MethodOptions) Method() string

type MethodPatch

type MethodPatch struct{}

func (MethodPatch) Method

func (MethodPatch) Method() string

type MethodPost

type MethodPost struct{}

func (MethodPost) Method

func (MethodPost) Method() string

type MethodPut

type MethodPut struct{}

func (MethodPut) Method

func (MethodPut) Method() string

type MethodTrace

type MethodTrace struct{}

func (MethodTrace) Method

func (MethodTrace) Method() string

type NoContent

type NoContent struct{}

type OperationInfo

type OperationInfo struct {
	Server

	ID     string
	Method string
	Route  string
}

+gengo:injectable:provider

func OperationInfoFromContext

func OperationInfoFromContext(ctx context.Context) (*OperationInfo, bool)

func (*OperationInfo) Init

func (v *OperationInfo) Init(ctx context.Context) error

func (*OperationInfo) InjectContext

func (p *OperationInfo) InjectContext(ctx context.Context) context.Context

func (OperationInfo) UserAgent

func (s OperationInfo) UserAgent() string

type PathDescriber

type PathDescriber interface {
	Path() string
}

type RedirectDescriber

type RedirectDescriber interface {
	StatusCodeDescriber

	Location() *url.URL
}

type Request

type Request = http.Request

+gengo:injectable:provider

func RequestFromContext

func RequestFromContext(ctx context.Context) (*Request, bool)

type RequestInfo

type RequestInfo = httprequest.Request

type Response

type Response[T any] interface {
	Underlying() T
	StatusCodeDescriber
	ContentTypeDescriber
	CookiesDescriber
	courier.MetadataCarrier
}

func Redirect

func Redirect(statusCode int, location *url.URL) Response[any]

func Wrap

func Wrap[T any](v T, opts ...ResponseSettingFunc) Response[T]

type ResponseSetting

type ResponseSetting interface {
	SetStatusCode(statusCode int)
	SetLocation(location *url.URL)
	SetContentType(contentType string)
	SetMetadata(key string, values ...string)
	SetCookies(cookies []*http.Cookie)
}

type ResponseSettingFunc

type ResponseSettingFunc = func(s ResponseSetting)

func WithContentType

func WithContentType(contentType string) ResponseSettingFunc

func WithCookies

func WithCookies(cookies ...*http.Cookie) ResponseSettingFunc

func WithMetadata

func WithMetadata(key string, values ...string) ResponseSettingFunc

func WithStatusCode

func WithStatusCode(statusCode int) ResponseSettingFunc

type ResponseWriter

type ResponseWriter interface {
	WriteResponse(ctx context.Context, rw http.ResponseWriter, req RequestInfo) error
}

type RouteDescriber

type RouteDescriber interface {
	MethodDescriber
	PathDescriber
}

+gengo:injectable:provider

func RouteDescriberFromContext

func RouteDescriberFromContext(ctx context.Context) (RouteDescriber, bool)

type Server

type Server struct {
	Name    string
	Version string
}

func (Server) UserAgent

func (s Server) UserAgent() string

type StatusCodeDescriber

type StatusCodeDescriber interface {
	StatusCode() int
}

type WithHeader

type WithHeader interface {
	Header() http.Header
}