top
(README.md)
Msgpack implementation for Golang
=================================

Supports:
- Primitives, arrays, maps, structs and interface{}.
- time.Time.
- Appengine *datastore.Key and datastore.Cursor.
- Extensions for user defined types.
- Tags.

API docs: http://godoc.org/github.com/vmihailenco/msgpack

Installation
------------

Install:

    go get github.com/vmihailenco/msgpack

Usage
-----

Examples:

    func ExampleEncode() {
        b, err := msgpack.Marshal(true)
        fmt.Printf("%v %#v\n", err, b)
        // Output: <nil> []byte{0xc3}
    }

    func ExampleDecode() {
        var out bool
        err := msgpack.Unmarshal([]byte{0xc3}, &out)
        fmt.Println(err, out)
        // Output: <nil> true
    }

    func ExampleMapStringInterface() {
        in := map[string]interface{}{"foo": 1, "hello": "world"}
        b, err := msgpack.Marshal(in)
        _ = err

        var out map[string]interface{}
        err = msgpack.Unmarshal(b, &out)
        fmt.Printf("%v %#v\n", err, out)
        // Output: <nil> map[string]interface {}{"foo":1, "hello":"world"}
    }

    func ExampleRecursiveMapStringInterface() {
        buf := &bytes.Buffer{}

        enc := msgpack.NewEncoder(buf)
        in := map[string]interface{}{"foo": map[string]interface{}{"hello": "world"}}
        _ = enc.Encode(in)

        dec := msgpack.NewDecoder(buf)
        dec.DecodeMapFunc = func(d *msgpack.Decoder) (interface{}, error) {
            n, err := d.DecodeMapLen()
            if err != nil {
                return nil, err
            }

            m := make(map[string]interface{}, n)
            for i := 0; i < n; i++ {
                mk, err := d.DecodeString()
                if err != nil {
                    return nil, err
                }

                mv, err := d.DecodeInterface()
                if err != nil {
                    return nil, err
                }

                m[mk] = mv
            }
            return m, nil
        }
        out, err := dec.DecodeInterface()
        fmt.Printf("%v %#v\n", err, out)
        // Output: <nil> map[string]interface {}{"foo":map[string]interface {}{"hello":"world"}}
    }

Extensions
----------

Look at [appengine.go](https://github.com/vmihailenco/msgpack/blob/master/appengine.go) for example.

Imported only in test by 1 package(s)

  1. github.com/ChannelMeter/msgpack

Imports 1 package(s)

  1. github.com/vmihailenco/bufio

Test imports 3 package(s)

  1. github.com/ugorji/go-msgpack
  2. launchpad.net/gocheck
  3. github.com/ugorji/go/codec