binding

package

v0.13.2 Latest Latest Go to latest Published: Mar 25, 2025 License: MIT, Apache-2.0 Imports: 10 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/hopeio/utils

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func Bind(c fiber.Ctx, obj interface{}) error
func BindBody(r fiber.Ctx, obj interface{}) error
func BindHeader(c fiber.Ctx, obj interface{}) error
func BindQuery(c fiber.Ctx, obj interface{}) error
func BindUri(c fiber.Ctx, obj interface{}) error
func BindWith(c fiber.Ctx, obj interface{}, b Binding) error
func NewReq[REQ any](c fiber.Ctx) (*REQ, error)
func SetTag(tag string)
type ArgsSource
- func (form *ArgsSource) HasValue(key string) bool
- func (form *ArgsSource) Peek(key string) ([]string, bool)
- func (form *ArgsSource) TrySet(value reflect.Value, field *reflect.StructField, key string, ...) (isSet bool, err error)
type Binding
type BindingBody
type CtxSource
- func (form *CtxSource) Peek(key string) ([]string, bool)
- func (form *CtxSource) TrySet(value reflect.Value, field *reflect.StructField, key 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, key 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) HasValue(key string) bool
- func (q QuerySource) Peek(key string) ([]string, bool)

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	CustomBody    = &bodyBinding{name: "json", unmarshaller: json.Unmarshal}
	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 BindHeader ¶ added in v0.12.0

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

func BindQuery ¶

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

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

func BindUri ¶

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

BindWith binds the passed struct pointer using the specified binding engine. BindUri binds the passed struct pointer using binding.Uri.

func BindWith ¶ added in v0.12.0

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

func NewReq ¶

func NewReq[REQ any](c fiber.Ctx) (*REQ, error)

func SetTag ¶

func SetTag(tag string)

Types ¶

type ArgsSource ¶ added in v0.3.8

type ArgsSource fasthttp.Args

func (*ArgsSource) HasValue ¶ added in v0.12.1

func (form *ArgsSource) HasValue(key string) bool

func (*ArgsSource) Peek ¶ added in v0.3.8

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

func (*ArgsSource) TrySet ¶ added in v0.3.8

func (form *ArgsSource) TrySet(value reflect.Value, field *reflect.StructField, key 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
}

type BindingBody ¶

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

type CtxSource ¶ added in v0.3.8

type CtxSource fasthttp.RequestCtx

func (*CtxSource) Peek ¶ added in v0.3.8

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

func (*CtxSource) TrySet ¶ added in v0.3.8

func (form *CtxSource) TrySet(value reflect.Value, field *reflect.StructField, key 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 ¶ added in v0.3.8

type HeaderSource fasthttp.RequestHeader

func (*HeaderSource) Peek ¶ added in v0.3.8

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

func (*HeaderSource) TrySet ¶ added in v0.3.8

func (form *HeaderSource) TrySet(value reflect.Value, field *reflect.StructField, key 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 ¶ added in v0.3.8

type MultipartRequest fasthttp.Request

func (*MultipartRequest) TrySet ¶ added in v0.3.8

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) HasValue ¶ added in v0.12.1

func (q QuerySource) HasValue(key string) bool

func (QuerySource) Peek ¶

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

Source Files ¶

View all Source files

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