fill

Documentation

Overview

Package fill assigns arbitrary values to struct fields using reflection. "fill" is case-insensitive, and obeys the "json" field tag if present. It's primary use is to support decoding data from a number of serialization formats (JSON,YAML,CBOR) into an intermediate map[string]interface{} value which can then be used to "fill" arbitrary struct values

Index

• Variables
• func GetPathValue(path string, input interface{}) (interface{}, error)
• func SetPathValue(path string, val interface{}, output interface{}) error
• func Struct(fields map[string]interface{}, output interface{}) error
• type ArbitrarySetter
• type ErrorCollector
  • func NewErrorCollector() *ErrorCollector
  • func (c *ErrorCollector) Add(err error) bool
  • func (c *ErrorCollector) AsSingleError() error
  • func (c *ErrorCollector) PopField()
  • func (c *ErrorCollector) PushField(fieldName string)
• type FieldError
  • func (c *FieldError) Error() string

Variables

var (
	// ErrNotFound is returned when a field isn't found
	ErrNotFound = fmt.Errorf("not found")
)

Functions

func GetPathValue

func GetPathValue(path string, input interface{}) (interface{}, error)

GetPathValue gets a value from the input struct, accessed using the path of dot-separated fields

func SetPathValue

func SetPathValue(path string, val interface{}, output interface{}) error

SetPathValue sets a value on a the output struct, accessed using the path of dot-separated fields

func Struct

func Struct(fields map[string]interface{}, output interface{}) error

Struct fills in the values of an arbitrary structure using an already deserialized map of nested data. Fields names are case-insensitive. Unknown fields are treated as an error, *unless* the output structure implements the ArbitrarySetter interface.

Types

type ArbitrarySetter

type ArbitrarySetter interface {
	SetArbitrary(string, interface{}) error
}

ArbitrarySetter should be implemented by structs that can store arbitrary fields in a private map.

type ErrorCollector

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

ErrorCollector collects errors, merging them into one, while noting the path where they happen

func NewErrorCollector

func NewErrorCollector() *ErrorCollector

NewErrorCollector creates a new ErrorCollector

func (*ErrorCollector) Add

func (c *ErrorCollector) Add(err error) bool

Add adds a non-nil error to the ErrorCollector, noting the path where the error happened

func (*ErrorCollector) AsSingleError

func (c *ErrorCollector) AsSingleError() error

AsSingleError returns the collected errors as a single error, or nil if there are none

func (*ErrorCollector) PopField

func (c *ErrorCollector) PopField()

PopField removes the most recent field from the current path

func (*ErrorCollector) PushField

func (c *ErrorCollector) PushField(fieldName string)

PushField adds a field to the current path

type FieldError

type FieldError struct {
	Got  string
	Want string
	Val  interface{}
}

FieldError represents an error when a value does not match the expected type

func (*FieldError) Error

func (c *FieldError) Error() string

Error displays the text version of the FieldError