diff options
Diffstat (limited to 'internal/zlibx/reader.go')
| -rw-r--r-- | internal/zlibx/reader.go | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/internal/zlibx/reader.go b/internal/zlibx/reader.go index 80bbbb58..9a4b4315 100644 --- a/internal/zlibx/reader.go +++ b/internal/zlibx/reader.go @@ -3,11 +3,14 @@ // license that can be found in the LICENSE file. /* -Package zlib implements reading and writing of zlib format compressed data, +Package zlibx implements reading of zlib format compressed data, as specified in RFC 1950. This package differs from the standard library's compress/zlib package -in that it pools readers to reduce allocations. Writers are unchanged. +in that it pools readers to reduce allocations. Writing is unsupported. + +THis package will likely be refactorered much more for our specific +use case of only doing full decompressions to byte slices. Note that closing the reader causes it to be returned to a pool for reuse. Therefore, the caller must not retain references to the |