binding

Documentation

Index

• Constants
• Variables
• func Bind(c *gin.Context, obj interface{}) error
• func BindJSON(c *gin.Context, obj interface{}) error
• func BindQuery(c *gin.Context, obj interface{}) error
• func BindXML(c *gin.Context, obj interface{}) error
• func BindYAML(c *gin.Context, obj interface{}) error
• func DecodeMsgPack(r io.Reader, obj interface{}) error
• func MustBindWith(c *gin.Context, obj interface{}, b Binding) error
• func NewReq[REQ any](c *gin.Context) (*REQ, error)
• func SetTag(tag string)
• func ShouldBind(c *gin.Context, obj interface{}) error
• func ShouldBindBodyWith(c *gin.Context, obj interface{}, bb BindingBody) (err error)
• func ShouldBindJSON(c *gin.Context, obj interface{}) error
• func ShouldBindQuery(c *gin.Context, obj interface{}) error
• func ShouldBindUri(r *gin.Context, obj interface{}) error
• func ShouldBindWith(c *gin.Context, obj interface{}, b Binding) error
• func ShouldBindXML(c *gin.Context, obj interface{}) error
• func ShouldBindYAML(c *gin.Context, obj interface{}) error
• func Validate(obj interface{}) error
• type Binding
  • func Body(contentType string) Binding
  • func Default(method string, contentType string) Binding
• type BindingBody

Constants

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"
)

Variables

var (
	JSON          = jsonBinding{}
	XML           = xmlBinding{}
	Query         = queryBinding{}
	FormPost      = formPostBinding{}
	FormMultipart = formMultipartBinding{}
	Uri           = uriBinding{}
	ProtoBuf      = protobufBinding{}
	MsgPack       = msgpackBinding{}
	YAML          = yamlBinding{}
	Header        = headerBinding{}
)

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

Functions

func Bind

func Bind(c *gin.Context, obj interface{}) error

func BindJSON

func BindJSON(c *gin.Context, obj interface{}) error

BindJSON is a shortcut for c.MustBindWith(obj, binding.JSON).

func BindQuery

func BindQuery(c *gin.Context, obj interface{}) error

BindQuery is a shortcut for c.MustBindWith(obj, binding.Query).

func BindXML

func BindXML(c *gin.Context, obj interface{}) error

BindXML is a shortcut for c.MustBindWith(obj, binding.BindXML).

func BindYAML

func BindYAML(c *gin.Context, obj interface{}) error

BindYAML is a shortcut for c.MustBindWith(obj, binding.YAML).

func DecodeMsgPack

func DecodeMsgPack(r io.Reader, obj interface{}) error

func MustBindWith

func MustBindWith(c *gin.Context, obj interface{}, b Binding) error

MustBindWith binds the passed struct pointer using the specified binding engine. It will abort the request with HTTP 400 if any error occurs. See the binding package.

func NewReq

func NewReq[REQ any](c *gin.Context) (*REQ, error)

func SetTag

func SetTag(tag string)

func ShouldBind

func ShouldBind(c *gin.Context, obj interface{}) error

ShouldBind checks the Content-Type to select a binding engine automatically, Depending the "Content-Type" header different bindings are used:

"application/json" --> JSON binding
"application/xml"  --> XML binding

otherwise --> returns an error It parses the request's body as JSON if Content-Type == "application/json" using JSON or XML as a JSON input. It decodes the json payload into the struct specified as a pointer. Like c.GinBind() but this method does not set the response status code to 400 and abort if the json is not valid.

func ShouldBindBodyWith

func ShouldBindBodyWith(c *gin.Context, obj interface{}, bb BindingBody) (err error)

ShouldBindBodyWith is similar with ShouldBindWith, but it stores the request body into the context, and reuse when it is called again.

NOTE: This method reads the body before binding. So you should use ShouldBindWith for better performance if you need to call only once.

func ShouldBindJSON

func ShouldBindJSON(c *gin.Context, obj interface{}) error

ShouldBindJSON is a shortcut for c.ShouldBindWith(obj, binding.JSON).

func ShouldBindQuery

func ShouldBindQuery(c *gin.Context, obj interface{}) error

ShouldBindQuery is a shortcut for c.ShouldBindWith(obj, binding.Query).

func ShouldBindUri

func ShouldBindUri(r *gin.Context, obj interface{}) error

ShouldBindUri binds the passed struct pointer using the specified binding engine.

func ShouldBindWith

func ShouldBindWith(c *gin.Context, obj interface{}, b Binding) error

ShouldBindWith binds the passed struct pointer using the specified binding engine. See the binding package.

func ShouldBindXML

func ShouldBindXML(c *gin.Context, obj interface{}) error

ShouldBindXML is a shortcut for c.ShouldBindWith(obj, binding.XML).

func ShouldBindYAML

func ShouldBindYAML(c *gin.Context, obj interface{}) error

ShouldBindYAML is a shortcut for c.ShouldBindWith(obj, binding.YAML).

func Validate

func Validate(obj interface{}) error

Types

type Binding

type Binding interface {
	Name() string
	Bind(*gin.Context, 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.

func Body

func Body(contentType string) Binding

func Default

func Default(method string, contentType string) Binding

Default returns the appropriate Binding instance based on the HTTP method and the content type.

type BindingBody

type BindingBody interface {
	Binding
	BindBody([]byte, interface{}) error
}

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