Method Header

bind.go:241–252

Header binds the request header strings into the struct, map[string]string and map[string][]string. Returns *BindError on parse failure (manual mode) or *Error with status 400 (auto-handling mode).

(out any)

// Header binds the request header strings into the struct, map[string]string and map[string][]string.
// Returns *BindError on parse failure (manual mode) or *Error with status 400 (auto-handling mode).
func (b *Bind) Header(out any) error {
	bind := binder.GetFromThePool[*binder.HeaderBinding](&binder.HeaderBinderPool)
	bind.EnableSplitting = b.ctx.App().config.EnableSplittingOnParsers

	defer releasePooledBinder(&binder.HeaderBinderPool, bind)

	if err := b.returnBindErr(bind.Bind(b.ctx.Request(), out), BindSourceHeader); err != nil {
		return err
	}

	return b.validateStruct(out)
}

// RespHeader binds the response header strings into the struct, map[string]string and map[string][]string.
// Returns *BindError on parse failure (manual mode) or *Error with status 400 (auto-handling mode).