decode

Documentation

Overview

Package decode contains decoders for various HTTP artefacts

Index

• func All(dst interface{}, r *http.Request) error
• func Form(dst interface{}, r *http.Request) error
• func ID(name string, r *http.Request) (resource.ID, error)
• func Param(name string, r *http.Request) (string, error)
• func Query(dst interface{}, query url.Values) error
• func RegisterConverter(v any, fn schema.Converter)
• func Route(dst interface{}, r *http.Request) error

Functions

func All

func All(dst interface{}, r *http.Request) error

All populates the struct pointed to by dst with query params, req body params and request path variables, respectively, with path variables taking precedence over body params, and body params over query params.

func Form

func Form(dst interface{}, r *http.Request) error

Form decodes an HTTP request's POST form contents into dst.

func ID

func ID(name string, r *http.Request) (resource.ID, error)

ID retrieves a single parameter by name from the request and parses into a resource ID.

func Param

func Param(name string, r *http.Request) (string, error)

Param retrieves a single parameter by name from the request, first checking the body (if POST/PUT/PATCH) and the query, falling back to looking for a path variable.

func Query

func Query(dst interface{}, query url.Values) error

Query unmarshals a query string (k1=v1&k2=v2...) into dst.

func RegisterConverter

func RegisterConverter(v any, fn schema.Converter)

func Route

func Route(dst interface{}, r *http.Request) error

Route decodes a mux route parameters (e.g. /foo/{bar}) into dst.