Skip to content

Commit b8c9213

Browse files
committed
Document last_mode to be able to reference it
1 parent ee3c6c7 commit b8c9213

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

Doc/library/compression.zstd.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -285,6 +285,13 @@ Compressing and decompressing data in memory
285285
:meth:`~.compress` will be written into a new frame and
286286
*cannot* reference past data.
287287

288+
.. attribute:: last_mode
289+
290+
The last mode passed to either :meth:`~.compress` or :meth:`~.flush`.
291+
The value can be one of :attr:`~.CONTINUE`, :attr:`~.FLUSH_BLOCK`, or
292+
:attr:`~.FLUSH_FRAME`. The initial value is :attr:`~.FLUSH_FRAME`,
293+
signifying that the compressor is at the start of a new frame.
294+
288295

289296
.. class:: ZstdDecompressor(zstd_dict=None, options=None)
290297

0 commit comments

Comments
 (0)