ZipArchiveLib::CZstdCompressor::COptions Struct Reference

#include <ZstdCompressor.h>

Inheritance diagram for ZipArchiveLib::CZstdCompressor::COptions:

Public Member Functions
CZipCompressor::COptions *	Clone () const
int	GetType () const

Public Attributes
bool	m_bEnableLdm
bool	m_bUseMagiclessFrames
bool	m_bWriteContentSize
int	m_iThreads
int	m_iWindowLog
ZSTD_strategy	m_iZstdStrategy
Public Attributes inherited from ZipArchiveLib::CBaseLibCompressor::COptions
bool	m_bDetectLibMemoryLeaks
Public Attributes inherited from CZipCompressor::COptions
int	m_iBufferSize

Additional Inherited Members
Public Types inherited from CZipCompressor::COptions
enum	Constants { cDefaultBufferSize = 2 * 65536 }

Detailed Description

Represents options of the CZstdCompressor.

See also

Compressing Data

CZipArchive::SetCompressionOptions

Member Function Documentation

Clone()

CZipCompressor::COptions * ZipArchiveLib::CZstdCompressor::COptions::Clone ( ) const

inlinevirtual

Clones the current options object.

Returns

The cloned object of the same type as the current object.

Implements CZipCompressor::COptions.

GetType()

int ZipArchiveLib::CZstdCompressor::COptions::GetType ( ) const

inlinevirtual

Returns the type of the compressor to which the current options apply.

Returns

The type of the compressor. It can be one of the CompressorType values.

Implements CZipCompressor::COptions.

Member Data Documentation

m_bEnableLdm

bool ZipArchiveLib::CZstdCompressor::COptions::m_bEnableLdm

Enable long-distance matching (LDM).

m_bUseMagiclessFrames

bool ZipArchiveLib::CZstdCompressor::COptions::m_bUseMagiclessFrames

Write magicless frames to reduce per-file overhead (default: false).

m_bWriteContentSize

bool ZipArchiveLib::CZstdCompressor::COptions::m_bWriteContentSize

Include content size in zstd frame header when known (default: false).

m_iThreads

int ZipArchiveLib::CZstdCompressor::COptions::m_iThreads

Number of threads to use for compression (0 means single-threaded). Requires ZSTD_MULTITHREAD to be defined in the _features.h file.

m_iWindowLog

int ZipArchiveLib::CZstdCompressor::COptions::m_iWindowLog

Custom windowLog when greater than 0; 0 means unset (use zstd default).

For compression: Sets the compression window size via ZSTD_c_windowLog. When using LDM or high compression levels, you may need to increase this value.

For decompression: Sets the maximum window size the decompressor will allocate memory for via ZSTD_d_windowLogMax. This must be at least as large as the windowLog used during compression. When decompressing archives created with custom window sizes, set this to match or exceed the compression windowLog.

Using the same value for both compression and decompression ensures compatibility.

m_iZstdStrategy

ZSTD_strategy ZipArchiveLib::CZstdCompressor::COptions::m_iZstdStrategy

Zstd compression strategy as defined in ZSTD_strategy enum.

---

The documentation for this struct was generated from the following file:

• ZstdCompressor.h