From 33bba4574b2db48fa8e346fd73370b10643e48b4 Mon Sep 17 00:00:00 2001 From: Emma Smith Date: Thu, 29 May 2025 21:37:43 -0700 Subject: [PATCH] gh-134906: Document CompressionParameter.content_size_flag (GH-134907) * Document CompressionParameter.content_size_flag (cherry picked from commit 5f60d0fcccbf6676f5bc924f05452bd5321446f0) Co-authored-by: Emma Smith --- Doc/library/compression.zstd.rst | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/Doc/library/compression.zstd.rst b/Doc/library/compression.zstd.rst index 1e1802155a19ec..35bcbc2bfd8eac 100644 --- a/Doc/library/compression.zstd.rst +++ b/Doc/library/compression.zstd.rst @@ -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