urlpath

package

v0.3.7 Latest Latest Go to latest Published: Nov 26, 2024 License: BSD-3-Clause Imports: 4 Imported by: 0

Details

This section is empty.

This section is empty.

func Parse(r *http.Request, schema Schema) error

Parse will parse the URL path vars from r given the element names and parsers defined in schema.

This method only works with requests being processed by handlers of a gorilla/mux.

func ParseValues(values map[string]string, schema Schema) error

ParseValues will parse the parameters in vars given the element names and parsers defined in schema.

Most use cases will be parsing values coming from an *http.Request, which can be done conveniently with Parse.

type Parameter string

A Parameter is a named element of a URL route, encoded such that a gorilla router interprets it as a path parameter.

func (p Parameter) Name() string

Name returns the name of the parameter.

func (p Parameter) String() string

type Parser interface {
	Parse(string) error
}

A Parser parses raw input into a destination variable.

func Int(i *int) Parser

Int creates a Parser that will parse a path element into i.

func String(s *string) Parser

String creates a parser that will parse a path element into s.

func UInt64(i *uint64) Parser

type Schema map[Parameter]Parser

A Schema describes how path variables should be parsed. Currently only int and string types are supported.