fasthttp

Documentation

Index

• Constants
• func MustNew(opts ...Option) *bundle
• func New(opts ...Option) (*bundle, error)
• type CORSConfig
• type DecoderFunc
• type Option
  • func Listen(addr string) Option
  • func WithBufferSize(read, write int) Option
  • func WithCORS(cfg CORSConfig) Option
  • func WithCustomRPC(in ronykit.IncomingRPCFactory, out ronykit.OutgoingRPCFactory) Option
  • func WithLogger(l ronykit.Logger) Option
  • func WithPredicateKey(key string) Option
  • func WithServerName(name string) Option
  • func WithWebsocketEndpoint(endpoint string) Option
• type Params
• type Selector
  • func DELETE(path string) Selector
  • func GET(path string) Selector
  • func PATCH(path string) Selector
  • func POST(path string) Selector
  • func PUT(path string) Selector
  • func REST(method, path string) Selector
  • func RPC(predicate string) Selector
  • func (r Selector) GetEncoding() ronykit.Encoding
  • func (r Selector) GetMethod() string
  • func (r Selector) GetPath() string
  • func (r Selector) GetPredicate() string
  • func (r Selector) Query(q string) interface{}
  • func (r *Selector) SetEncoding(enc ronykit.Encoding) *Selector

Constants

const (
	MethodGet      = "GET"     // RFC 7231, 4.3.1
	MethodHead     = "HEAD"    // RFC 7231, 4.3.2
	MethodPost     = "POST"    // RFC 7231, 4.3.3
	MethodPut      = "PUT"     // RFC 7231, 4.3.4
	MethodPatch    = "PATCH"   // RFC 5789
	MethodDelete   = "DELETE"  // RFC 7231, 4.3.5
	MethodConnect  = "CONNECT" // RFC 7231, 4.3.6
	MethodOptions  = "OPTIONS" // RFC 7231, 4.3.7
	MethodTrace    = "TRACE"   // RFC 7231, 4.3.8
	MethodWildcard = "*"
)

HTTP methods were copied from net/http.

Functions

func MustNew

func MustNew(opts ...Option) *bundle

func New

func New(opts ...Option) (*bundle, error)

Types

type CORSConfig

type CORSConfig struct {
	AllowedHeaders []string
	AllowedMethods []string
	AllowedOrigins []string
	ExposedHeaders []string
}

type DecoderFunc

type DecoderFunc = func(bag Params, data []byte) (ronykit.Message, error)

type Option

type Option func(b *bundle)

func Listen

func Listen(addr string) Option

func WithBufferSize

func WithBufferSize(read, write int) Option

func WithCORS

func WithCORS(cfg CORSConfig) Option

func WithCustomRPC

func WithCustomRPC(in ronykit.IncomingRPCFactory, out ronykit.OutgoingRPCFactory) Option

func WithLogger

func WithLogger(l ronykit.Logger) Option

func WithPredicateKey

func WithPredicateKey(key string) Option

func WithServerName

func WithServerName(name string) Option

func WithWebsocketEndpoint

func WithWebsocketEndpoint(endpoint string) Option

type Params

type Params = httpmux.Params

type Selector

type Selector struct {
	Method    string
	Path      string
	Predicate string
	Decoder   DecoderFunc
	Encoding  ronykit.Encoding
}

Selector implements ronykit.RouteSelector and also ronykit.RPCRouteSelector and ronykit.RESTRouteSelector

func DELETE

func DELETE(path string) Selector

DELETE a shortcut for REST(http.MethodDelete, path)

func GET

func GET(path string) Selector

GET a shortcut for REST(http.MethodGet, path)

func PATCH

func PATCH(path string) Selector

PATCH a shortcut for REST(http.MethodPatch, path)

func POST

func POST(path string) Selector

POST a shortcut for REST(http.MethodPost, path)

func PUT

func PUT(path string) Selector

PUT a shortcut for REST(http.MethodPut, path)

func REST

func REST(method, path string) Selector

REST returns a Selector which acts on http requests.

func RPC

func RPC(predicate string) Selector

RPC returns a Selector which acts on websocket requests

func (Selector) GetEncoding

func (r Selector) GetEncoding() ronykit.Encoding

func (Selector) GetMethod

func (r Selector) GetMethod() string

func (Selector) GetPath

func (r Selector) GetPath() string

func (Selector) GetPredicate

func (r Selector) GetPredicate() string

func (Selector) Query

func (r Selector) Query(q string) interface{}

func (*Selector) SetEncoding

func (r *Selector) SetEncoding(enc ronykit.Encoding) *Selector