context

Documentation

Index

• Variables
• func GetRoutePath(req *http.Request) string
• func RouteParams(ctx context.Context) map[string]interface{}
• func WithRouteContext(ctx context.Context, rctx *RoutingContext) context.Context
• type Context
• type RoutingContext
  • func GetRouteContextPath(req *http.Request) (context.Context, *RoutingContext, string)
  • func NewRouteContext(prefix, path string) *RoutingContext
  • func RouteContext(ctx context.Context) *RoutingContext
  • func (rctx *RoutingContext) Add(key string, v interface{})
  • func (rctx RoutingContext) Clone() *RoutingContext
  • func (rctx *RoutingContext) Format(f fmt.State, verb rune)
  • func (rctx *RoutingContext) Get(key string) (interface{}, error, bool)
  • func (rctx *RoutingContext) GetInt(key string) (x int, err error, ok bool)
  • func (rctx *RoutingContext) GetIntSlice(key string) (x []int, err error, ok bool)
  • func (rctx *RoutingContext) GetSlice(key string) (x []interface{}, err error, ok bool)
  • func (rctx *RoutingContext) GetString(key string) (x string, err error, ok bool)
  • func (rctx *RoutingContext) GetStringSlice(key string) (x []string, err error, ok bool)
  • func (rctx *RoutingContext) Init(prefix, path string)
  • func (rctx *RoutingContext) Next() (*RoutingContext, string)
  • func (rctx *RoutingContext) Path() string
  • func (rctx *RoutingContext) Set(key string, v interface{})
  • func (rctx *RoutingContext) Step(prefix string) *RoutingContext
  • func (rctx *RoutingContext) String() string

Variables

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

Functions

func GetRoutePath

func GetRoutePath(req *http.Request) string

GetRoutePath returns the Path to route, either from our RoutingContext, or from the Request's URL

func RouteParams

func RouteParams(ctx context.Context) map[string]interface{}

RouteParams returns the Routing map of parameters from a http.Request Context.

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
	RouteParams  map[string]interface{}
}

func GetRouteContextPath

func GetRouteContextPath(req *http.Request) (context.Context, *RoutingContext, string)

GetRouteContextPath returns a RoutingContext and the corresponding RoutePath. If the Context doesn't contain a RoutingContext one will be created

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) Add

func (rctx *RoutingContext) Add(key string, v interface{})

Append value for a RouteParam

func (RoutingContext) Clone

func (rctx RoutingContext) Clone() *RoutingContext

Clone() creates a copy of a RoutingContext object

func (*RoutingContext) Format

func (rctx *RoutingContext) Format(f fmt.State, verb rune)

Format formats the RoutingContext according to the fmt.Formatter interface

%s string corresponding to the full path, including prefix %q quoted strings corresponding to prefix and path, separated by a comma %+q same as %q but also including the pattern %v same as %+q %#v same as %v but also including the parameters %# v same as %#v but parameters are indented

func (*RoutingContext) Get

func (rctx *RoutingContext) Get(key string) (interface{}, error, bool)

Get item from RouteParams

func (*RoutingContext) GetInt

func (rctx *RoutingContext) GetInt(key string) (x int, err error, ok bool)

Get int parameter from RouteContext

func (*RoutingContext) GetIntSlice

func (rctx *RoutingContext) GetIntSlice(key string) (x []int, err error, ok bool)

Get slice of int parameters from RouteContext

func (*RoutingContext) GetSlice

func (rctx *RoutingContext) GetSlice(key string) (x []interface{}, err error, ok bool)

Get slice of interface{} parameters from RouteContext

func (*RoutingContext) GetString

func (rctx *RoutingContext) GetString(key string) (x string, err error, ok bool)

Get string parameter from RouteContext

func (*RoutingContext) GetStringSlice

func (rctx *RoutingContext) GetStringSlice(key string) (x []string, err error, ok bool)

Get slice of string parameters from RouteContext

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

Path returns to the full path in a string, including prefix

func (*RoutingContext) Set

func (rctx *RoutingContext) Set(key string, v interface{})

Sets value for a RouteParam

func (*RoutingContext) Step

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

func (*RoutingContext) String

func (rctx *RoutingContext) String() string

String returns to the full path in a string, including prefix