Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/vmihailenco/msgpack

msgpack.org[Go] MessagePack encoding for Golang
https://github.com/vmihailenco/msgpack

encoding go golang msgpack serialization

Last synced: 4 days ago
JSON representation

msgpack.org[Go] MessagePack encoding for Golang

Host: GitHub
URL: https://github.com/vmihailenco/msgpack
Owner: vmihailenco
License: bsd-2-clause
Created: 2012-10-27T13:17:38.000Z (about 12 years ago)
Default Branch: v5
Last Pushed: 2024-06-04T10:05:14.000Z (6 months ago)
Last Synced: 2024-11-25T11:52:11.191Z (18 days ago)
Topics: encoding, go, golang, msgpack, serialization
Language: Go
Homepage: https://msgpack.uptrace.dev/
Size: 697 KB
Stars: 2,396
Watchers: 37
Forks: 237
Open Issues: 42
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

go-awesome - vmihailenco/msgpack - supports msgpack (Open source library / Serialization)
awesome-golang-repositories - msgpack

README

        # MessagePack encoding for Golang

[![Build Status](https://travis-ci.org/vmihailenco/msgpack.svg)](https://travis-ci.org/vmihailenco/msgpack)

[![PkgGoDev](https://pkg.go.dev/badge/github.com/vmihailenco/msgpack/v5)](https://pkg.go.dev/github.com/vmihailenco/msgpack/v5)

[![Documentation](https://img.shields.io/badge/msgpack-documentation-informational)](https://msgpack.uptrace.dev/)

[![Chat](https://discordapp.com/api/guilds/752070105847955518/widget.png)](https://discord.gg/rWtp5Aj)

> msgpack is brought to you by :star: [**uptrace/uptrace**](https://github.com/uptrace/uptrace).

> Uptrace is an [open source APM](https://uptrace.dev/get/open-source-apm.html) and blazingly fast

> [distributed tracing tool](https://get.uptrace.dev/compare/distributed-tracing-tools.html) powered

> by OpenTelemetry and ClickHouse. Give it a star as well!

## Resources

- [Documentation](https://msgpack.uptrace.dev)

- [Chat](https://discord.gg/rWtp5Aj)

- [Reference](https://pkg.go.dev/github.com/vmihailenco/msgpack/v5)

- [Examples](https://pkg.go.dev/github.com/vmihailenco/msgpack/v5#pkg-examples)

## Features

- Primitives, arrays, maps, structs, time.Time and interface{}.

- Appengine \*datastore.Key and datastore.Cursor.

- [CustomEncoder]/[CustomDecoder] interfaces for custom encoding.

- [Extensions](https://pkg.go.dev/github.com/vmihailenco/msgpack/v5#example-RegisterExt) to encode

  type information.

- Renaming fields via `msgpack:"my_field_name"` and alias via `msgpack:"alias:another_name"`.

- Omitting individual empty fields via `msgpack:",omitempty"` tag or all

  [empty fields in a struct](https://pkg.go.dev/github.com/vmihailenco/msgpack/v5#example-Marshal-OmitEmpty).

- [Map keys sorting](https://pkg.go.dev/github.com/vmihailenco/msgpack/v5#Encoder.SetSortMapKeys).

- Encoding/decoding all

  [structs as arrays](https://pkg.go.dev/github.com/vmihailenco/msgpack/v5#Encoder.UseArrayEncodedStructs)

  or

  [individual structs](https://pkg.go.dev/github.com/vmihailenco/msgpack/v5#example-Marshal-AsArray).

- [Encoder.SetCustomStructTag] with [Decoder.SetCustomStructTag] can turn msgpack into drop-in

  replacement for any tag.

- Simple but very fast and efficient

  [queries](https://pkg.go.dev/github.com/vmihailenco/msgpack/v5#example-Decoder.Query).

[customencoder]: https://pkg.go.dev/github.com/vmihailenco/msgpack/v5#CustomEncoder

[customdecoder]: https://pkg.go.dev/github.com/vmihailenco/msgpack/v5#CustomDecoder

[encoder.setcustomstructtag]:

  https://pkg.go.dev/github.com/vmihailenco/msgpack/v5#Encoder.SetCustomStructTag

[decoder.setcustomstructtag]:

  https://pkg.go.dev/github.com/vmihailenco/msgpack/v5#Decoder.SetCustomStructTag

## Installation

msgpack supports 2 last Go versions and requires support for

[Go modules](https://github.com/golang/go/wiki/Modules). So make sure to initialize a Go module:

```shell

go mod init github.com/my/repo

```

And then install msgpack/v5 (note _v5_ in the import; omitting it is a popular mistake):

```shell

go get github.com/vmihailenco/msgpack/v5

```

## Quickstart

```go

import "github.com/vmihailenco/msgpack/v5"

func ExampleMarshal() {

    type Item struct {

        Foo string

    }

    b, err := msgpack.Marshal(&Item{Foo: "bar"})

    if err != nil {

        panic(err)

    }

    var item Item

    err = msgpack.Unmarshal(b, &item)

    if err != nil {

        panic(err)

    }

    fmt.Println(item.Foo)

    // Output: bar

}

```

## See also

- [Golang ORM](https://github.com/uptrace/bun) for PostgreSQL, MySQL, MSSQL, and SQLite

- [Golang PostgreSQL](https://bun.uptrace.dev/postgres/)

- [Golang HTTP router](https://github.com/uptrace/bunrouter)

- [Golang ClickHouse ORM](https://github.com/uptrace/go-clickhouse)

## Contributors

Thanks to all the people who already contributed!