bind

Documentation

Index

• Constants
• Variables
• func All(_ string, _ any, _ reflect.Value) bool
• func CamelCaseFields(c *Configuration)
• func ExtendsWith(extension ExtensionProvider) func(*Configuration)
• func IncludeEmpty(c *Configuration)
• func IsField(key string, _ any, sv reflect.Value) bool
• func IsNotField(key string, _ any, sv reflect.Value) bool
• func NewInTool(bindConfig Configuration, dp structs.DirectiveProvider) *structs.Tool
• func NewOutTool(bindConfig Configuration, dp structs.DirectiveProvider) *structs.Tool
• func OmitEmpty(c *Configuration)
• func PascalCaseFields(c *Configuration)
• func RegisterStashFieldFunction(name, sourceKey string, include InclusionPredicate)
• func RegisterUnstashFieldFunction(name, destinationKey string, include InclusionPredicate, ...)
• func UseStashed(stashed, _ any) any
• type Binder
  • func NewBinder(options ...func(*Configuration)) *Binder
  • func (b *Binder) In(data map[string]any, v any, optional ...structs.ToolContext) gomerr.Gomerr
  • func (b *Binder) Out(v any, optional ...structs.ToolContext) (map[string]any, gomerr.Gomerr)
• type Configuration
  • func CopyConfigurationWithOptions(b Configuration, options ...func(*Configuration)) Configuration
  • func NewConfiguration(options ...func(*Configuration)) Configuration
• type ExtensionProvider
• type InclusionPredicate
  • func IfAll(predicates ...InclusionPredicate) InclusionPredicate
  • func IfAny(predicates ...InclusionPredicate) InclusionPredicate
  • func NameMatches(names ...string) InclusionPredicate
• type UnstashConflictResolver
  • func MergeStashed(include InclusionPredicate) UnstashConflictResolver

Constants

const (
	InKey  = "$_gomer_bind_in"
	OutKey = "$_gomer_bind_out"
)

Variables

var (
	PascalCaseFn casingFn = func(fieldName string) string { return fieldName } // Exported fields are already PascalCase
	CamelCaseFn  casingFn = func(fieldName string) string {

		firstChar := fieldName[0]
		if 'A' <= firstChar && firstChar <= 'Z' {
			firstChar += 'a' - 'A'
		}
		return string(firstChar) + fieldName[1:]
	}
)

Functions

func All

func All(_ string, _ any, _ reflect.Value) bool

func CamelCaseFields

func CamelCaseFields(c *Configuration)

func ExtendsWith

func ExtendsWith(extension ExtensionProvider) func(*Configuration)

func IncludeEmpty

func IncludeEmpty(c *Configuration)

func IsField

func IsField(key string, _ any, sv reflect.Value) bool

func IsNotField

func IsNotField(key string, _ any, sv reflect.Value) bool

func NewInTool

func NewInTool(bindConfig Configuration, dp structs.DirectiveProvider) *structs.Tool

NewInTool

<name> -> Default input value matching <name>. If name == "" then name = b.DataCase(StructField.Name) =<static> -> Application-defined static value $<function> -> Application-defined dynamic value ?<directive> -> Applied iff field.IsZero(). Supports chaining (e.g. "query.aName?header.A-Source?=aDefault") <directive>&<right> -> Applies the left directive followed by the right (e.g. "input&$transform) <directive>!<right> -> Applies the left directive and, if it succeeds, the right - -> Explicitly not bound from any input

func NewOutTool

func NewOutTool(bindConfig Configuration, dp structs.DirectiveProvider) *structs.Tool

NewOutTool

+ -> Use field name as value's key. Required if EmptyDirectiveHandling == skipField <name> -> Use 'name' as value's key (if PayloadBindingPrefix != "", form is similar to header) =<static> -> Static output value $<function> -> Function-derived output value ?<directive> -> Applied iff field.IsZero(). Supports chaining (e.g. "?$foo?=last") <directive>&<right> -> Will apply the left directive followed by the right (e.g. "=OutValue&header.X-My-Header) <directive>!<right> -> Applies the left directive and, if it succeeds, the right - -> Explicitly not included in the output

Except for '-', each of the above can be combined with an ",omitempty" or ",includempty" qualifier that acts like '-' or '+' respectively if the field's value is its zero Value.

func OmitEmpty

func OmitEmpty(c *Configuration)

func PascalCaseFields

func PascalCaseFields(c *Configuration)

func RegisterStashFieldFunction

func RegisterStashFieldFunction(name, sourceKey string, include InclusionPredicate)

func RegisterUnstashFieldFunction

func RegisterUnstashFieldFunction(name, destinationKey string, include InclusionPredicate, createIntermediates bool)

func UseStashed

func UseStashed(stashed, _ any) any

Types

type Binder

type Binder struct {
	InTool  *structs.Tool
	OutTool *structs.Tool
}

Binder holds a configured pair of in/out tools for binding data to and from structs. Create one via NewBinder and pass it explicitly to the components that need it.

func NewBinder

func NewBinder(options ...func(*Configuration)) *Binder

NewBinder creates a Binder with the provided configuration options.

binder := bind.NewBinder(bind.CamelCaseFields, bind.OmitEmpty)

func (*Binder) In

func (b *Binder) In(data map[string]any, v any, optional ...structs.ToolContext) gomerr.Gomerr

In binds data into v using this Binder's InTool.

func (*Binder) Out

func (b *Binder) Out(v any, optional ...structs.ToolContext) (map[string]any, gomerr.Gomerr)

Out binds v's fields into a map using this Binder's OutTool.

type Configuration

type Configuration struct {
	// contains filtered or unexported fields
}

func CopyConfigurationWithOptions

func CopyConfigurationWithOptions(b Configuration, options ...func(*Configuration)) Configuration

func NewConfiguration

func NewConfiguration(options ...func(*Configuration)) Configuration

type ExtensionProvider

type ExtensionProvider interface {
	structs.ApplierProvider
	Type() string
}

type InclusionPredicate

type InclusionPredicate func(key string, value any, sv reflect.Value) bool

func IfAll

func IfAll(predicates ...InclusionPredicate) InclusionPredicate

func IfAny

func IfAny(predicates ...InclusionPredicate) InclusionPredicate

func NameMatches

func NameMatches(names ...string) InclusionPredicate

type UnstashConflictResolver

type UnstashConflictResolver func(stashed, destination any) any

func MergeStashed

func MergeStashed(include InclusionPredicate) UnstashConflictResolver