Skip to content

docs: document version migration differences #84

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
efegokdemir wants to merge 1 commit into
base: v6
Choose a base branch
from
Open

docs: document version migration differences #84

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,23 @@

See [CHANGELOG.md](CHANGELOG.md) for full details and the [v6.0.0 release](https://github.com/Basekick-Labs/msgpack/releases/tag/v6.0.0).

## Version migration notes

### Migrating from v5 to v6

- Update the module and import path from `github.com/vmihailenco/msgpack/v5` to `github.com/Basekick-Labs/msgpack/v6`.
- v6 includes the performance and safety changes listed in the [v6 changelog](CHANGELOG.md#v600-basekick-labs-fork), including pooled encoding, `MarshalAppend`, byte-slice decoding fast paths, and allocation limits.
- Review the map-decoding change before upgrading: decoding into a non-nil `map[string]interface{}` now reuses and merges into that map instead of replacing it. Pass a nil map to retain replacement semantics.
- v6 adds `SetPoolBufferLimit` for applications that need to tune pooled buffer retention and requires Go 1.25 or newer.

### Migrating from v4 to v5

- `Encode`, `Decode`, `Marshal`, and `Unmarshal` changed to take one argument; use `EncodeMulti` and `DecodeMulti` for multiple values.
- Typed integer methods and the extensions API were added.
- `SetMapDecodeFunc` became `SetMapDecoder`, `StructAsArray` became `UseArrayEncodedStructs`, and `SortMapKeys` became `SetSortMapKeys`.
- `UseJSONTag` was removed; use `SetCustomStructTag("json")` instead.
- Numeric encoding became type-preserving by default; use the compact-integer option when the older compact behavior is required.

## Resources

- [Discord](https://discord.gg/nxnWfUxsdm)
Expand Down