context

Documentation

Index

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

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 *RoutingContext) 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 = context.Context

type RoutingContext

type RoutingContext struct {
	RoutePrefix  string
	RoutePath    string
	RoutePattern string
}

func NewRouteContext

func NewRouteContext(prefix, path string) *RoutingContext

NewRouteContext returns a new RoutingContext object.

func RouteContext

func RouteContext(ctx context.Context) *RoutingContext

RouteContext returns a RoutingContext object from a http.Request Context.

func (RoutingContext) Clone

func (rctx RoutingContext) Clone() *RoutingContext

Clone() creates a copy of a RoutingContext object

func (*RoutingContext) Init

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

func (*RoutingContext) Next

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

func (*RoutingContext) Path

func (rctx *RoutingContext) Path() string

func (*RoutingContext) Step

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