Add Buffer.WriteByte and WriteString methods #691
Merged
Conversation
This file contains 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
These methods are equivalent to `AppendByte` and `AppendString`, but their signatures are compatible with [bytes.Buffer](https://godoc.org/bytes#Buffer) and [bufio.Writer](https://godoc.org/bufio#Writer). This allows to use `Buffer` where `bytes.Buffer` was expected without extra cost of wrapping. One example is msgpack library which expects `Writer` to implement `WriteByte` and `WriteString`, otherwise it is wrapped which incurs extra allocation: https://github.com/vmihailenco/msgpack/blob/master/encode.go#L63-L67
|
|
Codecov Report
@@ Coverage Diff @@
## master #691 +/- ##
=======================================
Coverage 98.07% 98.07%
=======================================
Files 45 45
Lines 2027 2031 +4
=======================================
+ Hits 1988 1992 +4
Misses 30 30
Partials 9 9
Continue to review full report at Codecov.
|
smira
added a commit
to smira/zap-msgpack-encoder
that referenced
this pull request
Mar 26, 2019
We anyway need to cache in sync.Pool instances of msgpack Encoder object, and this object is bound to Writer instance (Buffer in our case). There's no way to reset encoder to use different buffer, and there's no way to avoid buffer from being recycled if returned, so it's easier to use bytes.Buffer which has necessary APIs to avoid extra allocations (see uber-go/zap#691). The only allocation left in the benchmark is from msgpack's EncodeTime function, PR is submitted for it: vmihailenco/msgpack#224
prashantv
approved these changes
Jun 24, 2021
abhinav
approved these changes
Jun 24, 2021
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.
These methods are equivalent to
AppendByteandAppendString, buttheir signatures are compatible with bytes.Buffer and bufio.Writer.
This allows to use
Bufferwherebytes.Bufferwas expected withoutextra cost of wrapping. One example is msgpack library which
expects
Writerto implementWriteByteandWriteString, otherwiseit is wrapped which incurs extra allocation:
https://github.com/vmihailenco/msgpack/blob/master/encode.go#L63-L67