route

Documentation

Index

• type Result
  • func AcquireResult() *Result
  • func (r *Result) CopyTo(dst *Result) *Result
  • func (a *Result) Equal(b *Result) bool
  • func (r *Result) RedirectURIWithQueryString(ctx *fasthttp.RequestCtx) []byte
  • func (r *Result) Release()
  • func (r *Result) Reset()
  • func (r *Result) RewriteURIWithQueryString(ctx *fasthttp.RequestCtx) []byte
• type Route
  • func NewRoute(rcfg config.Route) (*Route, error)
  • func (r *Route) Match(method, path []byte) bool
• type Routes
  • func NewRoutes(cfg config.Config) (*Routes, error)
  • func (rs *Routes) CachedRoute(method, path []byte, off int) *Result
  • func (rs *Routes) CachedRouteCtx(ctx *fasthttp.RequestCtx, off int) *Result
  • func (rs *Routes) IsNextIfNotFound(i int) bool
  • func (rs *Routes) Route(method, path []byte, off int) *Result

Types

type Result

type Result struct {
	StatusCode        int
	StatusMessage     []byte
	RewriteURI        []byte
	RedirectURI       []byte
	AppendQueryString bool
	Handler           string
	Filters           util.StringSet
	RouteIndex        int
}

Result represents a result of routing.

func AcquireResult

func AcquireResult() *Result

AcquireResult returns an empty Result object from the pool.

The returned Result may be returned to the pool with Release when no longer needed. This allows reducing GC load.

func (*Result) CopyTo

func (r *Result) CopyTo(dst *Result) *Result

CopyTo copies all the result to dst.

func (*Result) Equal

func (a *Result) Equal(b *Result) bool

Equal reports whether a and b.

func (*Result) RedirectURIWithQueryString

func (r *Result) RedirectURIWithQueryString(ctx *fasthttp.RequestCtx) []byte

RedirectURIWithQueryString returns r.RedirectURI with queryString.

func (*Result) Release

func (r *Result) Release()

Release returns the object acquired via AcquireResult to the pool.

Do not access the released Result object, otherwise data races may occur.

func (*Result) Reset

func (r *Result) Reset()

Reset clears result.

func (*Result) RewriteURIWithQueryString

func (r *Result) RewriteURIWithQueryString(ctx *fasthttp.RequestCtx) []byte

RewriteURIWithQueryString returns r.RewriteURI with queryString.

type Route

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

Route represents a route settings that can be used to match requested URLs.

func NewRoute

func NewRoute(rcfg config.Route) (*Route, error)

NewRoute creates a new Route by the provided rcfg.

func (*Route) Match

func (r *Route) Match(method, path []byte) bool

Match matches the provided method and path.

type Routes

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

Routes represents a list of routes that can be used to match requested URLs.

func NewRoutes

func NewRoutes(cfg config.Config) (*Routes, error)

NewRoutes creates a new Routes the provided cfg.Routes.

func (*Routes) CachedRoute

func (rs *Routes) CachedRoute(method, path []byte, off int) *Result

CachedRoute provides Read-Through caching for rs.Route if the cache is enabled.

func (*Routes) CachedRouteCtx

func (rs *Routes) CachedRouteCtx(ctx *fasthttp.RequestCtx, off int) *Result

CachedRouteCtx provides Read-Through caching for rs.Route if the cache is enabled.

func (*Routes) IsNextIfNotFound

func (rs *Routes) IsNextIfNotFound(i int) bool

func (*Routes) Route

func (rs *Routes) Route(method, path []byte, off int) *Result

Route find routes by the provided method and path and returns a new Result.