c31efec9e0
full diff: https://github.com/mitchellh/mapstructure/compare/v1.0.0...v1.3.2 v1.3.2 - Decode into interface type with a struct value is supported v1.3.1 - Squash should only squash embedded structs. v1.3.0 - Added `",omitempty"` support. This will ignore zero values in the source structure when encoding. v1.2.3 - Fix duplicate entries in Keys list with pointer values. v1.2.2 - Do not add unsettable (unexported) values to the unused metadata key or "remain" value. v1.2.1 - Go modules checksum mismatch fix v1.2.0 - Added support to capture unused values in a field using the `",remain"` value in the mapstructure tag. There is an example to showcase usage. - Added `DecoderConfig` option to always squash embedded structs - `json.Number` can decode into `uint` types - Empty slices are preserved and not replaced with nil slices - Fix panic that can occur in when decoding a map into a nil slice of structs - Improved package documentation for godoc v1.1.2 - Fix error when decode hook decodes interface implementation into interface type. v1.1.1 - Fix panic that can happen in `decodePtr` v1.1.0 - Added `StringToIPHookFunc` to convert `string` to `net.IP` and `net.IPNet` - Support struct to struct decoding - If source map value is nil, then destination map value is nil (instead of empty) - If source slice value is nil, then destination slice value is nil (instead of empty) - If source pointer is nil, then destination pointer is set to nil (instead of allocated zero value of type) Signed-off-by: Sebastiaan van Stijn <github@gone.nl> |
||
|---|---|---|
| .. | ||
| LICENSE | ||
| README.md | ||
| decode_hooks.go | ||
| error.go | ||
| go.mod | ||
| mapstructure.go | ||
README.md
mapstructure 
mapstructure is a Go library for decoding generic map values to structures and vice versa, while providing helpful error handling.
This library is most useful when decoding values from some data stream (JSON,
Gob, etc.) where you don't quite know the structure of the underlying data
until you read a part of it. You can therefore read a map[string]interface{}
and use this library to decode it into the proper underlying native Go
structure.
Installation
Standard go get:
$ go get github.com/mitchellh/mapstructure
Usage & Example
For usage and examples see the Godoc.
The Decode function has examples associated with it there.
But Why?!
Go offers fantastic standard libraries for decoding formats such as JSON. The standard method is to have a struct pre-created, and populate that struct from the bytes of the encoded format. This is great, but the problem is if you have configuration or an encoding that changes slightly depending on specific fields. For example, consider this JSON:
{
"type": "person",
"name": "Mitchell"
}
Perhaps we can't populate a specific structure without first reading
the "type" field from the JSON. We could always do two passes over the
decoding of the JSON (reading the "type" first, and the rest later).
However, it is much simpler to just decode this into a map[string]interface{}
structure, read the "type" key, then use something like this library
to decode it into the proper structure.