Clarify encoding of varuint32 values. #562
Merged
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.
When encoding section sizes, tools will usually emit a patchable varuint32 value like 0xFFFFFFFF, reserving up to 5 bytes in the stream. Once the size is known, this is patched with the real size of the section which many not necessarily to take up 5 bytes, thus tools will need to encode leading zeros bytes. LEB128 supports this, but may be surprising to people writing decoders, hence this clarification.