Skip to content

Go library for decoding generic map values into native Go structures and vice versa.

License

Notifications You must be signed in to change notification settings

martinconic/mapstructure

This branch is 1 commit ahead of mitchellh/mapstructure:main.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

9cb7be3 · Jan 14, 2024
Apr 23, 2022
Apr 23, 2022
May 20, 2013
Jan 20, 2018
Apr 18, 2023
Apr 18, 2023
May 26, 2015
Jan 14, 2024
Apr 23, 2022
Nov 9, 2018
Apr 20, 2022
Jun 23, 2020
Apr 23, 2022

Repository files navigation

mapstructure Godoc

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.

About

Go library for decoding generic map values into native Go structures and vice versa.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Go 100.0%