diff options
Diffstat (limited to 'vendor/github.com/vmihailenco/msgpack/v5/README.md')
| -rw-r--r-- | vendor/github.com/vmihailenco/msgpack/v5/README.md | 100 |
1 files changed, 0 insertions, 100 deletions
diff --git a/vendor/github.com/vmihailenco/msgpack/v5/README.md b/vendor/github.com/vmihailenco/msgpack/v5/README.md deleted file mode 100644 index 038464f18..000000000 --- a/vendor/github.com/vmihailenco/msgpack/v5/README.md +++ /dev/null @@ -1,100 +0,0 @@ -# MessagePack encoding for Golang - -[](https://travis-ci.org/vmihailenco/msgpack) -[](https://pkg.go.dev/github.com/vmihailenco/msgpack/v5) -[](https://msgpack.uptrace.dev/) -[](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! - -<a href="https://github.com/vmihailenco/msgpack/graphs/contributors"> - <img src="https://contributors-img.web.app/image?repo=vmihailenco/msgpack" /> -</a> |