decoder

Documentation

Overview

Package decoder provides decoders.

Index

• Constants
• type FormURL
  • func NewFormURL(opts ...FormURLOptionsFunc) *FormURL
  • func (f *FormURL) ContentType() string
  • func (f *FormURL) Decode(r *http.Request, ptr any) error
• type FormURLOptionsFunc
  • func WithDisabledSplit() FormURLOptionsFunc
  • func WithSplitSymbol(splitSymbol string) FormURLOptionsFunc
• type JSON
  • func NewJSON() *JSON
  • func (j *JSON) ContentType() string
  • func (j *JSON) Decode(r *http.Request, ptr any) error
• type MultipartFile
  • func (f *MultipartFile) ContentType() string
• type MultipartFiles
  • func (mf MultipartFiles) Close() error
• type MultipartFormData
  • func NewMultipartFormData(opts ...MultipartFormDataOptionsFunc) *MultipartFormData
  • func (m *MultipartFormData) ContentType() string
  • func (m *MultipartFormData) Decode(r *http.Request, ptr any) error
• type MultipartFormDataOptionsFunc
  • func WithMaxMemory(maxMemory int64) MultipartFormDataOptionsFunc
• type XML
  • func NewXML() *XML
  • func (x *XML) ContentType() string
  • func (x *XML) Decode(r *http.Request, ptr any) error

Constants

const (
	// ContentTypeFormURL content-type header for url form decoder.
	ContentTypeFormURL = "application/x-www-form-urlencoded"
	// SplitSymbol array split symbol.
	SplitSymbol = ","
)

const (
	// ContentTypeJSON content-type header for json decoder.
	ContentTypeJSON = "application/json"
)

const (
	// ContentTypeMultipartFormData content-type header for multipart form-data decoder.
	ContentTypeMultipartFormData = "multipart/form-data"
)

const (
	// ContentTypeXML content-type header for xml decoder.
	ContentTypeXML = "application/xml"
)

Types

type FormURL

type FormURL struct {
	// contains filtered or unexported fields
}

FormURL url form decoder.

func NewFormURL

func NewFormURL(opts ...FormURLOptionsFunc) *FormURL

NewFormURL returns new url form decoder.

func (*FormURL) ContentType

func (f *FormURL) ContentType() string

ContentType returns content type of url form decoder.

func (*FormURL) Decode

func (f *FormURL) Decode(r *http.Request, ptr any) error

Decode decodes url form value from http request into ptr.

ptr must have a type of either struct or map.

type FormURLOptionsFunc

type FormURLOptionsFunc func(*FormURL)

FormURLOptionsFunc function for setting options.

func WithDisabledSplit

func WithDisabledSplit() FormURLOptionsFunc

WithDisabledSplit disables array splitting.

func WithSplitSymbol

func WithSplitSymbol(splitSymbol string) FormURLOptionsFunc

WithSplitSymbol sets array split symbol.

type JSON

type JSON struct{}

JSON json decoder.

func NewJSON

func NewJSON() *JSON

NewJSON returns new json decoder.

func (*JSON) ContentType

func (j *JSON) ContentType() string

ContentType returns content-type header value.

func (*JSON) Decode

func (j *JSON) Decode(r *http.Request, ptr any) error

Decode decodes request body into ptr.

type MultipartFile

type MultipartFile struct {
	Key    string
	File   multipart.File
	Header *multipart.FileHeader
}

MultipartFile parsed multipart form-data file.

func (*MultipartFile) ContentType

func (f *MultipartFile) ContentType() string

ContentType returns content type of parsed file.

type MultipartFiles

type MultipartFiles []*MultipartFile

MultipartFiles parsed multipart form-data files.

func (MultipartFiles) Close

func (mf MultipartFiles) Close() error

Close close all files.

type MultipartFormData

type MultipartFormData struct {
	// contains filtered or unexported fields
}

MultipartFormData multipart form-data decoder.

func NewMultipartFormData

func NewMultipartFormData(opts ...MultipartFormDataOptionsFunc) *MultipartFormData

NewMultipartFormData returns new multipart form-data decoder.

func (*MultipartFormData) ContentType

func (m *MultipartFormData) ContentType() string

ContentType returns content type of url form decoder.

func (*MultipartFormData) Decode

func (m *MultipartFormData) Decode(r *http.Request, ptr any) error

Decode decodes url form value from http request into ptr.

ptr must be pointer to a struct.

type MultipartFormDataOptionsFunc

type MultipartFormDataOptionsFunc func(*MultipartFormData)

MultipartFormDataOptionsFunc function for setting options.

func WithMaxMemory

func WithMaxMemory(maxMemory int64) MultipartFormDataOptionsFunc

WithMaxMemory sets max memory.

type XML

type XML struct{}

XML xml decoder.

func NewXML

func NewXML() *XML

NewXML returns new xml decoder.

func (*XML) ContentType

func (x *XML) ContentType() string

ContentType returns content-type header value.

func (*XML) Decode

func (x *XML) Decode(r *http.Request, ptr any) error

Decode decodes request body into ptr.