71 lines
2.0 KiB
Markdown
71 lines
2.0 KiB
Markdown
# MessagePack for Golang
|
|
|
|
[](https://pkg.go.dev/github.com/shamaton/msgpack)
|
|
|
|
[](https://goreportcard.com/report/github.com/shamaton/msgpack)
|
|
[](https://codecov.io/gh/shamaton/msgpack)
|
|
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fshamaton%2Fmsgpack?ref=badge_shield)
|
|
|
|
## Features
|
|
* Supported types : primitive / array / slice / struct / map / interface{} and time.Time
|
|
* Renaming fields via `msgpack:"field_name"`
|
|
* Omitting fields via `msgpack:"-"`
|
|
* Omitting empty fields via `msgpack:"field_name,omitempty"`
|
|
* Supports extend encoder / decoder [(example)](./msgpack_example_test.go)
|
|
* Can also Encoding / Decoding struct as array
|
|
|
|
## Installation
|
|
|
|
Current version is **msgpack/v2**.
|
|
```sh
|
|
go get -u github.com/shamaton/msgpack/v2
|
|
```
|
|
|
|
## Quick Start
|
|
```go
|
|
package main
|
|
|
|
import (
|
|
"github.com/shamaton/msgpack/v2"
|
|
"net/http"
|
|
)
|
|
|
|
type Struct struct {
|
|
String string
|
|
}
|
|
|
|
// simple
|
|
func main() {
|
|
v := Struct{String: "msgpack"}
|
|
|
|
d, err := msgpack.Marshal(v)
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
r := Struct{}
|
|
if err = msgpack.Unmarshal(d, &r); err != nil {
|
|
panic(err)
|
|
}
|
|
}
|
|
|
|
// streaming
|
|
func handle(w http.ResponseWriter, r *http.Request) {
|
|
var body Struct
|
|
if err := msgpack.UnmarshalRead(r, &body); err != nil {
|
|
panic(err)
|
|
}
|
|
if err := msgpack.MarshalWrite(w, body); err != nil {
|
|
panic(err)
|
|
}
|
|
}
|
|
```
|
|
|
|
## Benchmark
|
|
This result made from [shamaton/msgpack_bench](https://github.com/shamaton/msgpack_bench)
|
|
|
|
|
|
|
|
## License
|
|
|
|
This library is under the MIT License.
|