QgsZipUtils Class Reference

Provides utility functions for working with zip files. More...

#include <qgsziputils.h>

Static Public Member Functions
static bool	decodeGzip (const char *bytesIn, std::size_t size, QByteArray &bytesOut)
	Decodes gzip byte stream, returns true on success.
static bool	decodeGzip (const QByteArray &bytesIn, QByteArray &bytesOut)
	Decodes gzip byte stream, returns true on success.
static bool	encodeGzip (const QByteArray &bytesIn, QByteArray &bytesOut)
	Encodes gzip byte stream, returns true on success.
static const QStringList	files (const QString &zip)
	Returns the list of files within a zip file.
static bool	isZipFile (const QString &filename)
	Returns true if the file name is a zipped file ( i.e with a '.qgz' extension, false otherwise.
static bool	unzip (const QString &zip, const QString &dir, QStringList &files, bool checkConsistency=true)
	Unzip a zip file in an output directory.
static bool	zip (const QString &zip, const QStringList &files, bool overwrite=false)
	Zip the list of files in the zip file.

Detailed Description

Provides utility functions for working with zip files.

Since

QGIS 3.0

Definition at line 28 of file qgsziputils.h.

Member Function Documentation

decodeGzip() [1/2]

bool QgsZipUtils::decodeGzip ( const char *  bytesIn, std::size_t  size, QByteArray &  bytesOut  )

static

Decodes gzip byte stream, returns true on success.

Useful for reading vector tiles.

Note

Not available in Python bindings

Since

QGIS 3.26

Definition at line 209 of file qgsziputils.cpp.

decodeGzip() [2/2]

bool QgsZipUtils::decodeGzip ( const QByteArray &  bytesIn, QByteArray &  bytesOut  )

static

Decodes gzip byte stream, returns true on success.

Useful for reading vector tiles.

Note

Not available in Python bindings

Since

QGIS 3.26

Definition at line 204 of file qgsziputils.cpp.

encodeGzip()

bool QgsZipUtils::encodeGzip ( const QByteArray &  bytesIn, QByteArray &  bytesOut  )

static

Encodes gzip byte stream, returns true on success.

Useful for writing vector tiles.

Note

Not available in Python bindings

Since

QGIS 3.26

Definition at line 267 of file qgsziputils.cpp.

files()

const QStringList QgsZipUtils::files ( const QString &  zip )

static

Returns the list of files within a zip file.

Since

QGIS 3.30

Definition at line 309 of file qgsziputils.cpp.

isZipFile()

bool QgsZipUtils::isZipFile ( const QString &  filename )

static

Returns true if the file name is a zipped file ( i.e with a '.qgz' extension, false otherwise.

Parameters

filename

The name of the file

Returns

true if the file is zipped, false otherwise

Definition at line 32 of file qgsziputils.cpp.

unzip()

bool QgsZipUtils::unzip ( const QString &  zip, const QString &  dir, QStringList &  files, bool  checkConsistency = true  )

static

Unzip a zip file in an output directory.

Parameters

zip	The zip filename
dir	The output directory
files	The absolute path of unzipped files
checkConsistency	Perform additional stricter consistency checks on the archive, and error if they fail (since QGIS 3.30)

Returns

false if the zip filename does not exist, the output directory does not exist or is not writable.

Definition at line 37 of file qgsziputils.cpp.

zip()

bool QgsZipUtils::zip ( const QString &  zip, const QStringList &  files, bool  overwrite = false  )

static

Zip the list of files in the zip file.

If the zip file already exists (and overwrite is false) or is empty, an error is returned. If an input file does not exist, an error is also returned.

Parameters

zip	The zip filename
files	The absolute path to files to embed within the zip
overwrite	Set to true to allow overwriting existing files (since QGIS 3.44)

Definition at line 144 of file qgsziputils.cpp.

---

The documentation for this class was generated from the following files:

• /build/qgis-3.43.0+git20250410+32433f7016e+99sid/src/core/qgsziputils.h
• /build/qgis-3.43.0+git20250410+32433f7016e+99sid/src/core/qgsziputils.cpp