Skip to content

Commit b846d3a

Browse files
committed
Elaborate on the differences
1 parent ec8d3a0 commit b846d3a

File tree

1 file changed

+4
-12
lines changed

1 file changed

+4
-12
lines changed

README.rst

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -71,18 +71,10 @@ Differences with zlib and gzip modules
7171
+ ``isal_zlib`` only supports ``FLUSH``, ``SYNC_FLUSH`` and ``FULL_FLUSH``
7272
``FINISH`` is aliased to ``FULL_FLUSH`` (and works correctly as such).
7373
+ ``isal_zlib`` has a ``compressobj`` and ``decompressobj`` implementation.
74-
The resulting objects only support a maximum of 4 GB input for their
75-
``compress`` and ``decompress`` methods unlike ``zlib`` which supports
76-
an unlimited size. This difference arises because
77-
the zlib C library only supports very small amounts (64 KB) of input and the
78-
python zlibmodule.c has created a workaround so larger amounts can be
79-
supported. This workaround allows anything up to the maximum size that python
80-
can describe.
81-
However for isa-l the maximum supported size is 4GB. for isal_zlib it was
82-
decided that since the ``compressobj`` and ``decompressobj`` are only used in
83-
streaming applications, 4 GB is ample. This simplifies the underlying code
84-
quite a bit. If you need to compress or decompress larger sizes than 4 GB
85-
in memory then the ``compress`` and ``decompress`` methods support this.
74+
However, the unused_data and unconsumed_tail for the Decompress object, only
75+
work properly when using gzip compatible compression. (25 <= wbits <= 31).
76+
+ The flush implementation for the Compress object behavious differently from
77+
the zlib equivalent.
8678

8779
Contributing
8880
------------

0 commit comments

Comments
 (0)