Separate "crate version" from "wire format version" #540
Merged
bors[bot] merged 5 commits intoknurling-rs:mainfrom Jul 27, 2021
Merged
Separate "crate version" from "wire format version" #540bors[bot] merged 5 commits intoknurling-rs:mainfrom
bors[bot] merged 5 commits intoknurling-rs:mainfrom
Conversation
Member
|
|
Member
jonas-schievink
approved these changes
Jul 20, 2021
Contributor
jonas-schievink
left a comment
There was a problem hiding this comment.
Looks good, though some in-code docs would be good to have here, since this is quite important to get right.
Contributor
|
bors r+ |
Contributor
|
Build succeeded: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Depends on #539. Fixes #287.
This decouples the "wire format version" from the crate version (Cargo package version or git commit). Wire format version can now be bumped independently. This alleviates pains listed in #539., and more importantly it will allow making breaking changes to the wire format in a semver-minor
defmtcrate release. See #426.Version is
3to be able to retroactively number0.1.x = 1, 0.2.x = 2. A followup PR will add support todefmt-decoderto decode both version 2 and 3 concurrently.