binding

package module
v0.2.7 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 22, 2021 License: MIT Imports: 20 Imported by: 0

README

binding this is gin binding package, but with option tags

GoDoc Go.Dev reference Build Status codecov Action Status Go Report Card Licence Tag

Build with jsoniter

binding uses encoding/json as default json package, but you can change to jsoniter by build from other tags.

$ go build -tags=jsoniter .

Build without

binding uses msg,protobuf,yaml, you can build without them with tags.

   $ go build -tags=noprotopack,noyamlpack,nomsgpack .

note

*** binding tag same as validator which is validate not binding ***

References

Documentation

Index

Constants

View Source
const (
	MIMEJSON              = "application/json"
	MIMEHTML              = "text/html"
	MIMEXML               = "application/xml"
	MIMEXML2              = "text/xml"
	MIMEPlain             = "text/plain"
	MIMEPOSTForm          = "application/x-www-form-urlencoded"
	MIMEMultipartPOSTForm = "multipart/form-data"
	MIMEPROTOBUF          = "application/x-protobuf"
	MIMEMSGPACK           = "application/x-msgpack"
	MIMEMSGPACK2          = "application/msgpack"
	MIMEYAML              = "application/x-yaml"
)

Content-Type MIME of the most common data formats.

Variables

View Source
var (
	Form          = formBinding{}
	FormPost      = formPostBinding{}
	FormMultipart = formMultipartBinding{}
)

These implement the Binding interface and can be used to bind the data present in the request to struct instances.

View Source
var EnableDecoderDisallowUnknownFields = false

EnableDecoderDisallowUnknownFields is used to call the DisallowUnknownFields method on the JSON Decoder instance. DisallowUnknownFields causes the Decoder to return an error when the destination is a struct and the input contains object keys which do not match any non-ignored, exported fields in the destination.

View Source
var EnableDecoderUseNumber = false

EnableDecoderUseNumber is used to call the UseNumber method on the JSON Decoder instance. UseNumber causes the Decoder to unmarshal a number into an interface{} as a Number instead of as a float64.

View Source
var Header = headerBinding{}

These implement the Binding interface and can be used to bind the data present in the request to struct instances.

View Source
var JSON = jsonBinding{}

These implement the Binding interface and can be used to bind the data present in the request to struct instances.

View Source
var MsgPack = msgpackBinding{}

These implement the Binding interface and can be used to bind the data present in the request to struct instances.

View Source
var ProtoBuf = protobufBinding{}

These implement the Binding interface and can be used to bind the data present in the request to struct instances.

View Source
var Query = queryBinding{}

These implement the Binding interface and can be used to bind the data present in the request to struct instances.

View Source
var Uri = uriBinding{}

These implement the Binding interface and can be used to bind the data present in the request to struct instances.

View Source
var XML = xmlBinding{}

These implement the Binding interface and can be used to bind the data present in the request to struct instances.

View Source
var YAML = yamlBinding{}

These implement the Binding interface and can be used to bind the data present in the request to struct instances.

Functions

func DisableBindValidation added in v0.2.4

func DisableBindValidation()

DisableBindValidation closes the default validator.

func EnableJsonDecoderDisallowUnknownFields added in v0.2.4

func EnableJsonDecoderDisallowUnknownFields()

EnableJsonDecoderDisallowUnknownFields sets true for binding.EnableDecoderDisallowUnknownFields to call the DisallowUnknownFields method on the JSON Decoder instance.Which default value false.

func EnableJsonDecoderUseNumber added in v0.2.4

func EnableJsonDecoderUseNumber()

EnableJsonDecoderUseNumber sets true for EnableDecoderUseNumber to call the UseNumber method on the JSON Decoder instance.Which default value false.

Types

type Binding

type Binding interface {
	Name() string
	Bind(*http.Request, interface{}) error
}

Binding describes the interface which needs to be implemented for binding the data present in the request such as JSON request body, query parameters or the form POST.

type BindingBody

type BindingBody interface {
	Binding
	BindBody([]byte, interface{}) error
	BindReader(io.Reader, interface{}) error
}

BindingBody adds BindBody method to Binding. BindBody is similar with Bind, but it reads the body or io.Reader from supplied bytes instead of req.Body.

type BindingUri

type BindingUri interface {
	Name() string
	BindUri(map[string][]string, interface{}) error
}

BindingUri adds BindUri method to Binding. BindUri is similar with Bind, but it read the Params.

type Decoder added in v0.2.1

type Decoder interface {
	Name() string
	Decode(*http.Request, interface{}) error
}

Decoder decode data present in the request such as JSON request body, query parameters or the form POST.

type DecoderBody added in v0.2.1

type DecoderBody interface {
	Decoder
	DecodeBody([]byte, interface{}) error
	DecodeReader(io.Reader, interface{}) error
}

DecoderBody is similar with Decoder, but it reads the body from supplied bytes or io.Reader instead of req.Body.

type DecoderUri added in v0.2.1

type DecoderUri interface {
	Name() string
	DecodeUri(map[string][]string, interface{}) error
}

DecoderUri is similar with Decoder, but it read the Params.

type StructValidator

type StructValidator interface {
	// ValidateStruct can receive any kind of type and it should never panic, even if the configuration is not right.
	// If the received type is not a struct, any validation should be skipped and nil must be returned.
	// If the received type is a struct or pointer to a struct, the validation should be performed.
	// If the struct is not valid or the validation itself fails, a descriptive error should be returned.
	// Otherwise nil must be returned.
	ValidateStruct(interface{}) error
	// ValidateVar validates a single variable using tag style validation.
	ValidateVar(field interface{}, tag string) error
	// Engine returns the underlying validator engine which powers the
	// StructValidator implementation.
	Engine() *validator.Validate
}

StructValidator is the minimal interface which needs to be implemented in order for it to be used as the validator engine for ensuring the correctness of the request. Gin provides a default implementation for this using https://github.com/go-playground/validator/tree/v8.18.2.

var Validator StructValidator = &defaultValidator{}

Validator is the default validator which implements the StructValidator interface. It uses https://github.com/go-playground/validator/tree/v8.18.2 under the hood.

Directories

Path Synopsis
internal

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL