binding

Documentation

Index

• Variables
• func Bind(c fiber.Ctx, obj interface{}) error
• func BindBody(r fiber.Ctx, obj interface{}) error
• func BindQuery(c fiber.Ctx, obj interface{}) error
• func BindUri(c fiber.Ctx, obj interface{}) error
• func MustBindWith(c fiber.Ctx, obj interface{}, b Binding) error
• func NewReq[REQ any](c fiber.Ctx) (*REQ, error)
• func RegisterBodyBinding(name string, unmarshaller func(data []byte, obj any) error)
• func SetTag(tag string)
• func ShouldBind(c fiber.Ctx, obj interface{}) error
• func ShouldBindBody(c fiber.Ctx, obj interface{}) error
• func ShouldBindQuery(c fiber.Ctx, obj interface{}) error
• func ShouldBindUri(c fiber.Ctx, obj interface{}) error
• func ShouldBindWith(c fiber.Ctx, obj interface{}, b Binding) error
• type ArgsSource
  • func (form *ArgsSource) Peek(key string) ([]string, bool)
  • func (form *ArgsSource) TrySet(value reflect.Value, field *reflect.StructField, tagValue string, ...) (isSet bool, err error)
• type Binding
  • func Body(contentType []byte) Binding
  • func Default(method string, contentType []byte) Binding
• type BindingBody
• type CtxSource
  • func (form *CtxSource) Peek(key string) ([]string, bool)
  • func (form *CtxSource) TrySet(value reflect.Value, field *reflect.StructField, tagValue string, ...) (isSet bool, err error)
• type HeaderSource
  • func (form *HeaderSource) Peek(key string) ([]string, bool)
  • func (form *HeaderSource) TrySet(value reflect.Value, field *reflect.StructField, tagValue string, ...) (isSet bool, err error)
• type MultipartRequest
  • func (r *MultipartRequest) TrySet(value reflect.Value, field *reflect.StructField, key string, ...) (isSet bool, err error)
• type QuerySource
  • func (q QuerySource) Peek(key string) ([]string, bool)

Variables

var (
	CustomBody    = bodyBinding{/* contains filtered or unexported fields */}
	Query         = queryBinding{}
	FormPost      = formPostBinding{}
	FormMultipart = formMultipartBinding{}
	Uri           = uriBinding{}
	Header        = headerBinding{}
)

Functions

func Bind

func Bind(c fiber.Ctx, obj interface{}) error

func BindBody

func BindBody(r fiber.Ctx, obj interface{}) error

func BindQuery

func BindQuery(c fiber.Ctx, obj interface{}) error

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

func BindUri

func BindUri(c fiber.Ctx, obj interface{}) error

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

func MustBindWith

func MustBindWith(c fiber.Ctx, 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 fiber.Ctx) (*REQ, error)

func RegisterBodyBinding

func RegisterBodyBinding(name string, unmarshaller func(data []byte, obj any) error)

func SetTag

func SetTag(tag string)

func ShouldBind

func ShouldBind(c fiber.Ctx, 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 ShouldBindBody

func ShouldBindBody(c fiber.Ctx, obj interface{}) error

func ShouldBindQuery

func ShouldBindQuery(c fiber.Ctx, obj interface{}) error

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

func ShouldBindUri

func ShouldBindUri(c fiber.Ctx, obj interface{}) error

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

func ShouldBindWith

func ShouldBindWith(c fiber.Ctx, obj interface{}, b Binding) error

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

Types

type ArgsSource

type ArgsSource fasthttp.Args

func (*ArgsSource) Peek

func (form *ArgsSource) Peek(key string) ([]string, bool)

func (*ArgsSource) TrySet

func (form *ArgsSource) TrySet(value reflect.Value, field *reflect.StructField, tagValue string, opt mtos.SetOptions) (isSet bool, err error)

TrySet tries to set a value by request's form source (like map[string][]string)

type Binding

type Binding interface {
	Name() string

	Bind(fiber.Ctx, interface{}) error
}

func Body

func Body(contentType []byte) Binding

func Default

func Default(method string, contentType []byte) Binding

type BindingBody

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

type CtxSource

type CtxSource fasthttp.RequestCtx

func (*CtxSource) Peek

func (form *CtxSource) Peek(key string) ([]string, bool)

func (*CtxSource) TrySet

func (form *CtxSource) TrySet(value reflect.Value, field *reflect.StructField, tagValue string, opt mtos.SetOptions) (isSet bool, err error)

TrySet tries to set a value by request's form source (like map[string][]string)

type HeaderSource

type HeaderSource fasthttp.RequestHeader

func (*HeaderSource) Peek

func (form *HeaderSource) Peek(key string) ([]string, bool)

func (*HeaderSource) TrySet

func (form *HeaderSource) TrySet(value reflect.Value, field *reflect.StructField, tagValue string, opt mtos.SetOptions) (isSet bool, err error)

TrySet tries to set a value by request's form source (like map[string][]string)

type MultipartRequest

type MultipartRequest fasthttp.Request

func (*MultipartRequest) TrySet

func (r *MultipartRequest) TrySet(value reflect.Value, field *reflect.StructField, key string, opt mtos.SetOptions) (isSet bool, err error)

TrySet tries to set a value by the multipart request with the binding a form file

type QuerySource

type QuerySource map[string]string

func (QuerySource) Peek

func (q QuerySource) Peek(key string) ([]string, bool)