feat(s2n-quic-core): add ReceiveBuffer::copy_into_buf #2052
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.
Description of changes:
For an application that needs to copy data out into, for example, a tokio::io::ReadBuf, the current
ReceiveBuffer::pop
interface is less than ideal. The way it is implemented, it assumes that theBytesMut
will be passed around for copy-avoidance. Splitting bytes off from other chunks only to copy it and drop the new reference requires shared promotion and refcount increment/decrement.This change, instead, provides a
copy_into_buf
function that avoids thesplit
calls and instead usesBufMut::advance_mut
, which avoids the previously-mentioned downsides.Call-outs:
I updated the benchmarks to use the
copy_into_buf
function instead ofpop
to avoid oversampling on thepop
, especially since the benchmarks just discard the received chunk.Testing:
I've included a unit test showing it all working. Most of the implementation is shared with
pop
via the internalpop_transform
method.By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.