Skip to content

Commit

Permalink
Ensure reader buffer is flushed when extracting reader
Browse files Browse the repository at this point in the history
After the decoder stream has yielded all of the uncompressed data, it is possible for the input stream to still not be fully consumed.  This means if we extract the inner stream at this point, it will not be pointing to the end of the compressed data.

From the [zstd documentation](https://facebook.github.io/zstd/zstd_manual.html#Chapter9) for `ZSTD_decompressStream`:

> But if `output.pos == output.size`, there might be some data left within internal buffers.
> In which case, call ZSTD_decompressStream() again to flush whatever remains in the buffer.

This is only necessary if the caller wants the stream back, so at that point we can force an additional call to `ZSTD_decompressStream` by reading to a zero-length buffer.
  • Loading branch information
markbt committed Oct 19, 2023
1 parent 3ae7ad6 commit 299cd5b
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion src/stream/zio/reader.rs
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,13 @@ impl<R, D> Reader<R, D> {
}

/// Returns the inner reader.
pub fn into_inner(self) -> R {
pub fn into_inner(mut self) -> R
where
R: BufRead,
D: Operation,
{
// Ensure the input buffers have been flushed by reading to a zero-length buffer.
let _ = self.read(&mut [0; 0]);
self.reader
}

Expand Down

0 comments on commit 299cd5b

Please sign in to comment.