Compressor/decompressor description. More...

#include <cpl_compressor.h>

Public Attributes
int	nStructVersion
	Structure version.

const char *	pszId
	Id of the compressor/decompressor.

CPLCompressorType	eType
	Compressor type.

CSLConstList	papszMetadata
	Metadata, as a NULL terminated list of strings.

CPLCompressionFunc	pfnFunc
	Compressor/decompressor callback.

void *	user_data
	User data to provide to the callback.

Detailed Description

Compressor/decompressor description.

Member Data Documentation

◆ nStructVersion

int CPLCompressor::nStructVersion

Structure version.

Should be set to 1

◆ papszMetadata

CSLConstList CPLCompressor::papszMetadata

Metadata, as a NULL terminated list of strings.

Or NULL. The OPTIONS metadata key is reserved for compressors/decompressors to provide the available options as a XML string of the form <Options> <Option name='' type='' description='' default=''/> </Options>

◆ pfnFunc

CPLCompressionFunc CPLCompressor::pfnFunc

Compressor/decompressor callback.

Should NOT be NULL.

◆ pszId

const char* CPLCompressor::pszId

Id of the compressor/decompressor.

Should NOT be NULL.

◆ user_data

void* CPLCompressor::user_data

User data to provide to the callback.

May be NULL.

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

cpl_compressor.h