context

Documentation

Index

• Variables
• func WithRouteContext(ctx context.Context, rctx *Context) context.Context
• type Context
  • func NewRouteContext(prefix, path string) *Context
  • func RouteContext(ctx context.Context) *Context
  • func (rctx Context) Clone() *Context
  • func (rctx *Context) Init(prefix, path string)
  • func (rctx *Context) Next() (*Context, string)
  • func (rctx *Context) Path() string
  • func (rctx *Context) Step(prefix string) *Context

Variables

var (
	// RouteCtxKey is the context.Context key to store the request context.
	RouteCtxKey = context.NewContextKey("RouteContext")
)

Functions

func WithRouteContext

func WithRouteContext(ctx context.Context, rctx *Context) context.Context

WithRouteContext returns a new http.Request Context with a given mix routing Context object connected to it, so it can later be extracted using RouteContext()

Types

type Context

type Context struct {
	RoutePrefix  string
	RoutePath    string
	RoutePattern string
}

func NewRouteContext

func NewRouteContext(prefix, path string) *Context

NewRouteContext returns a new routing Context object.

func RouteContext

func RouteContext(ctx context.Context) *Context

RouteContext returns mix's routing Context object from a http.Request Context.

func (Context) Clone

func (rctx Context) Clone() *Context

Clone() creates a copy of a routing Context object

func (*Context) Init

func (rctx *Context) Init(prefix, path string)

func (*Context) Next

func (rctx *Context) Next() (*Context, string)

func (*Context) Path

func (rctx *Context) Path() string

func (*Context) Step

func (rctx *Context) Step(prefix string) *Context