History

Paul Hinze 8209b40526 vendor: Recapture deps w/ latest godep The original contents of `vendor` were inadvertently captured with an older version of `godep`. Here, we recapture dependencies by running the following: ``` godep restore -v cat Godeps/Godeps.json \| jq -r '.Deps[].ImportPath' \| xargs godep update -v ``` The newer godep makes the following changes as it captures dependencies: * Skips test files * Copies `LICENSE` / `PATENTS` files There is also an additional diff in `golang.org/x/sys/unix` that looks very similar to the diff between `master..c65f27f` in that repo, so I'm guessing that dependency was accidentally captured from master instead of the commit saved to `Godeps.json`. All in all, these changes should all be "more correct" and result in smaller diffs for any future updates made to dependencies.		2016-02-10 10:45:16 -06:00
..
.travis.yml	Vendor all dependencies w/ Godep	2016-01-29 15:08:48 -06:00
LICENSE	Vendor all dependencies w/ Godep	2016-01-29 15:08:48 -06:00
README.md	Vendor all dependencies w/ Godep	2016-01-29 15:08:48 -06:00
decode_hooks.go	Vendor all dependencies w/ Godep	2016-01-29 15:08:48 -06:00
error.go	Vendor all dependencies w/ Godep	2016-01-29 15:08:48 -06:00
mapstructure.go	Vendor all dependencies w/ Godep	2016-01-29 15:08:48 -06:00

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.