Skip to content

Commit e22731c

Browse files
committed
Add igzip_threaded to the README
1 parent 11f40bb commit e22731c

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

README.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,13 +45,17 @@ Acceleration Library (ISA-L) implements several key algorithms in `assembly
4545
language <https://en.wikipedia.org/wiki/Assembly_language>`_. This includes
4646
a variety of functions to provide zlib/gzip-compatible compression.
4747

48-
``python-isal`` provides the bindings by offering three modules:
48+
``python-isal`` provides the bindings by offering four modules:
4949

5050
+ ``isal_zlib``: A drop-in replacement for the zlib module that uses ISA-L to
5151
accelerate its performance.
5252
+ ``igzip``: A drop-in replacement for the gzip module that uses ``isal_zlib``
5353
instead of ``zlib`` to perform its compression and checksum tasks, which
5454
improves performance.
55+
+ ``igzip_threaded`` offers an ``open`` function which returns buffered read
56+
or write streams that can be used to read and write large files while
57+
escaping the GIL using one or multiple threads. This functionality only
58+
works for streaming, seeking is not supported.
5559
+ ``igzip_lib``: Provides compression functions which have full access to the
5660
API of ISA-L's compression functions.
5761

0 commit comments

Comments
 (0)