mapstructure

Documentation

Index

• func TextMarshalerHookFunc() mapstructure.DecodeHookFuncValue
• func YamlMarshalerHookFunc() mapstructure.DecodeHookFuncValue
• type Encoder
  • func New(cfg *EncoderConfig) *Encoder
  • func (e *Encoder) Encode(input any) (any, error)
• type EncoderConfig

Functions

func TextMarshalerHookFunc

func TextMarshalerHookFunc() mapstructure.DecodeHookFuncValue

TextMarshalerHookFunc returns a DecodeHookFuncValue that checks for the encoding.TextMarshaler interface and calls the MarshalText function if found.

func YamlMarshalerHookFunc

func YamlMarshalerHookFunc() mapstructure.DecodeHookFuncValue

YamlMarshalerHookFunc returns a DecodeHookFuncValue that checks for structs that have yaml tags but no mapstructure tags. If found, it will convert the struct to map[string]any using the yaml package, which respects the yaml tags. Ultimately, this allows mapstructure to later marshal the map[string]any in a generic way.

Types

type Encoder

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

An Encoder takes structured data and converts it into an interface following the mapstructure tags.

func New

func New(cfg *EncoderConfig) *Encoder

New returns a new encoder for the configuration.

func (*Encoder) Encode

func (e *Encoder) Encode(input any) (any, error)

Encode takes the input and uses reflection to encode it to an interface based on the mapstructure spec.

type EncoderConfig

type EncoderConfig struct {
	// EncodeHook, if set, is a way to provide custom encoding. It
	// will be called before structs and primitive types.
	EncodeHook mapstructure.DecodeHookFunc
}

EncoderConfig is the configuration used to create a new encoder.