binding

Documentation

Index

• Variables
• func Exec(req *http.Request, value interface{}) error
• func Register(contentType string, fn Binder)
• func RegisterCustomDecorder(fn CustomTypeDecoder, types []interface{}, fields []interface{})
• func RegisterTimeFormats(layouts ...string)
• type Binder
• type CustomTypeDecoder
• type File
  • func (f File) String() string
  • func (f File) Valid() bool

Variables

var MaxFileMemory int64 = 5 * 1024 * 1024

MaxFileMemory can be used to set the maximum size, in bytes, for files to be stored in memory during uploaded for multipart requests. See https://golang.org/pkg/net/http/#Request.ParseMultipartForm for more information on how this impacts file uploads.

Functions

func Exec

func Exec(req *http.Request, value interface{}) error

Exec will bind the interface to the request.Body. The type of binding is dependent on the "Content-Type" for the request. If the type is "application/json" it will use "json.NewDecoder". If the type is "application/xml" it will use "xml.NewDecoder". The default binder is "https://github.com/monoculum/formam".

func Register

func Register(contentType string, fn Binder)

Register maps a request Content-Type (application/json) to a Binder.

func RegisterCustomDecorder

func RegisterCustomDecorder(fn CustomTypeDecoder, types []interface{}, fields []interface{})

RegisterCustomDecorder allows to define custom type decoders.

func RegisterTimeFormats

func RegisterTimeFormats(layouts ...string)

RegisterTimeFormats allows to add custom time layouts that the binder will be able to use for decoding.

Types

type Binder

type Binder func(*http.Request, interface{}) error

Binder takes a request and binds it to an interface. If there is a problem it should return an error.

type CustomTypeDecoder

type CustomTypeDecoder func([]string) (interface{}, error)

CustomTypeDecoder converts a custom type from the request insto its exact type.

type File

type File struct {
	multipart.File
	*multipart.FileHeader
}

File holds information regarding an uploaded file

func (File) String

func (f File) String() string

func (File) Valid

func (f File) Valid() bool

Valid if there is an actual uploaded file