route

Documentation

Index

• func Bool(params map[string]string, name string) (bool, bool, error)
• func Float64(params map[string]string, name string) (float64, bool, error)
• func Int(params map[string]string, name string) (int, bool, error)
• func Int64(params map[string]string, name string) (int64, bool, error)
• func Match(pattern, requestPath string) (map[string]string, bool)
• func Required(params map[string]string, name string) (string, error)
• func String(params map[string]string, name string) (string, bool, error)
• func Uint(params map[string]string, name string) (uint, bool, error)
• func Uint64(params map[string]string, name string) (uint64, bool, error)
• type ParamError
  • func (err ParamError) Error() string
  • func (err ParamError) Unwrap() error

Functions

func Bool

func Bool(params map[string]string, name string) (bool, bool, error)

Bool returns an optional route param decoded as a bool.

func Float64

func Float64(params map[string]string, name string) (float64, bool, error)

Float64 returns an optional route param decoded as a float64.

func Int

func Int(params map[string]string, name string) (int, bool, error)

Int returns an optional route param decoded as an int.

func Int64

func Int64(params map[string]string, name string) (int64, bool, error)

Int64 returns an optional route param decoded as an int64.

func Match

func Match(pattern, requestPath string) (map[string]string, bool)

Match compares a concrete request path to a simple generated route pattern. Parameter segments use "{name}" and reject empty, ".", and ".." values. A final "{name...}" rest segment matches one or more remaining request segments; the captured value is those segments joined with "/".

func Required

func Required(params map[string]string, name string) (string, error)

Required returns a required route param.

func String

func String(params map[string]string, name string) (string, bool, error)

String returns an optional route param as a string.

func Uint

func Uint(params map[string]string, name string) (uint, bool, error)

Uint returns an optional route param decoded as a uint.

func Uint64

func Uint64(params map[string]string, name string) (uint64, bool, error)

Uint64 returns an optional route param decoded as a uint64.

Types

type ParamError

type ParamError struct {
	Name    string
	Type    string
	Missing bool
	Err     error
}

ParamError describes a failed route-param decode without exposing the raw request value.

func (ParamError) Error

func (err ParamError) Error() string

func (ParamError) Unwrap

func (err ParamError) Unwrap() error