Skip to content

gh-134906: Document CompressionParameter.content_size_flag #134907

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 30, 2025
Merged

gh-134906: Document CompressionParameter.content_size_flag #134907

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a0184e5
Document CompressionParameter.content_size_flag
emmatyping May 30, 2025
aeecf4e
Remove spurrious whitespace
emmatyping May 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions Doc/library/compression.zstd.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -615,6 +615,24 @@ Advanced parameter control

A value of zero causes the value to be selected automatically.

.. attribute:: content_size_flag

Write the size of the data to be compressed into the Zstandard frame
header when known prior to compressing.

This flag only takes effect under the following two scenarios:

* Calling :func:`compress` for one-shot compression
* Providing all of the data to be compressed in the frame in a single
:meth:`ZstdCompressor.compress` call, with the
:attr:`ZstdCompressor.FLUSH_FRAME` mode.

All other compression calls may not write the size information into the
frame header.

``True`` or ``1`` enable the content size flag while ``False`` or ``0``
disable it.

.. attribute:: checksum_flag

A four-byte checksum using XXHash64 of the uncompressed content is
Expand Down
Loading