QuaZip

https://stachenov.github.io/quazip/
Admin
QuaZip is a C++ wrapper around Minizip that provides Qt-compatible classes for reading and writing...
Tokens:111,297
Snippets:933
Trust Score:9.7
Update:5 months ago
Show doc for...
Tokens:
Raw
### Install QuaZip Library

Source: https://stachenov.github.io/quazip/index.html

After building, use this command to install the QuaZip library to your system. Ensure you replace 'wherever/you/want/your/build/to/be' with your actual build directory.

```bash
cmake --build wherever/you/want/your/build/to/be --target install
```

--------------------------------

### setup

Source: https://stachenov.github.io/quazip/classQuazipTextCodec-members.html

Protected static method to set up the codec. This is a protected static method.

```APIDOC
## setup()

### Description
Performs setup operations for the QuazipTextCodec. This is a protected static method, typically used internally.

### Method
protected static
```

--------------------------------

### QuaZip Functions starting with 'c'

Source: https://stachenov.github.io/quazip/functions_func_c.html

This section lists functions starting with 'c' available in QuaZip, along with the classes they belong to.

```APIDOC
## calculate()

### Description
Calculates a checksum. This function is available in QuaAdler32, QuaChecksum32, and QuaCrc32 classes.

### Method
Not applicable (function signature)

### Endpoint
Not applicable (function signature)

### Parameters
None explicitly documented.

### Request Example
None provided.

### Response
#### Success Response
- **Result** (QuaAdler32 | QuaChecksum32 | QuaCrc32) - The calculated checksum value.

#### Response Example
None provided.
```

```APIDOC
## caseSensitivity()

### Description
Gets the case sensitivity setting for the directory.

### Method
Not applicable (function signature)

### Endpoint
Not applicable (function signature)

### Parameters
None explicitly documented.

### Request Example
None provided.

### Response
#### Success Response
- **Sensitivity** (CaseSensitivity) - The current case sensitivity setting.

#### Response Example
None provided.
```

```APIDOC
## cd()

### Description
Changes the current directory within the zip archive.

### Method
Not applicable (function signature)

### Endpoint
Not applicable (function signature)

### Parameters
None explicitly documented.

### Request Example
None provided.

### Response
#### Success Response
- **Success** (bool) - True if the directory change was successful, false otherwise.

#### Response Example
None provided.
```

```APIDOC
## cdUp()

### Description
Moves the current directory up one level in the zip archive.

### Method
Not applicable (function signature)

### Endpoint
Not applicable (function signature)

### Parameters
None explicitly documented.

### Request Example
None provided.

### Response
#### Success Response
- **Success** (bool) - True if moving up was successful, false otherwise.

#### Response Example
None provided.
```

```APIDOC
## close()

### Description
Closes the file or archive, releasing any associated resources. This function is available in QuaGzipFile, QuaZIODevice, QuaZip, and QuaZipFile classes.

### Method
Not applicable (function signature)

### Endpoint
Not applicable (function signature)

### Parameters
None explicitly documented.

### Request Example
None provided.

### Response
#### Success Response
- **Success** (bool) - True if the close operation was successful, false otherwise.

#### Response Example
None provided.
```

```APIDOC
## compressDir()

### Description
Compresses a directory into a zip archive. This function is available in JlCompress and QuaCompress classes.

### Method
Not applicable (function signature)

### Endpoint
Not applicable (function signature)

### Parameters
None explicitly documented.

### Request Example
None provided.

### Response
#### Success Response
- **Success** (bool) - True if compression was successful, false otherwise.

#### Response Example
None provided.
```

```APIDOC
## compressFile()

### Description
Compresses a single file into a zip archive. This function is available in JlCompress and QuaCompress classes.

### Method
Not applicable (function signature)

### Endpoint
Not applicable (function signature)

### Parameters
None explicitly documented.

### Request Example
None provided.

### Response
#### Success Response
- **Success** (bool) - True if compression was successful, false otherwise.

#### Response Example
None provided.
```

```APIDOC
## compressFiles()

### Description
Compresses multiple files into a zip archive. This function is available in JlCompress and QuaCompress classes.

### Method
Not applicable (function signature)

### Endpoint
Not applicable (function signature)

### Parameters
None explicitly documented.

### Request Example
None provided.

### Response
#### Success Response
- **Success** (bool) - True if compression was successful, false otherwise.

#### Response Example
None provided.
```

```APIDOC
## compressSubDir()

### Description
Compresses a subdirectory into a zip archive. This function is available in JlCompress class.

### Method
Not applicable (function signature)

### Endpoint
Not applicable (function signature)

### Parameters
None explicitly documented.

### Request Example
None provided.

### Response
#### Success Response
- **Success** (bool) - True if compression was successful, false otherwise.

#### Response Example
None provided.
```

```APIDOC
## convertCaseSensitivity()

### Description
Converts the case sensitivity of the archive to the specified setting.

### Method
Not applicable (function signature)

### Endpoint
Not applicable (function signature)

### Parameters
None explicitly documented.

### Request Example
None provided.

### Response
#### Success Response
- **Success** (bool) - True if the conversion was successful, false otherwise.

#### Response Example
None provided.
```

```APIDOC
## count()

### Description
Gets the number of entries in the directory.

### Method
Not applicable (function signature)

### Endpoint
Not applicable (function signature)

### Parameters
None explicitly documented.

### Request Example
None provided.

### Response
#### Success Response
- **Count** (int) - The number of entries in the directory.

#### Response Example
None provided.
```

```APIDOC
## csize()

### Description
Gets the compressed size of the file entry.

### Method
Not applicable (function signature)

### Endpoint
Not applicable (function signature)

### Parameters
None explicitly documented.

### Request Example
None provided.

### Response
#### Success Response
- **Size** (qint64) - The compressed size of the file entry.

#### Response Example
None provided.
```

--------------------------------

### Example Usage of QuaExtract

Source: https://stachenov.github.io/quazip/classQuaExtract.html

Demonstrates a typical fluent API usage pattern for extracting an entire directory from a ZIP archive with a specified password.

```cpp
QuaExtract()
.withPassword("secret")
.extractDir("archive.zip", "output/");
```

--------------------------------

### Initialize QuaExtract Instance

Source: https://stachenov.github.io/quazip/classQuaExtract.html

Constructs a new QuaExtract object. This is the starting point for using the fluent API.

```cpp
#include <QuaExtract.h>
QuaExtract()
```

--------------------------------

### path

Source: https://stachenov.github.io/quazip/functions_func_p.html

Gets the path of the directory. Associated with the QuaZipDir class.

```APIDOC
## path()

### Description
Gets the path of the directory.

### Class
QuaZipDir

### Returns
- string: The path of the directory.
```

--------------------------------

### Iterating Through Files in a ZIP Archive

Source: https://stachenov.github.io/quazip/classQuaZipFile.html

This example demonstrates how to iterate through all files in a ZIP archive using an existing QuaZip object and QuaZipFile. Ensure to close each file after processing and the QuaZip object at the end.

```cpp
QuaZip zip("archive.zip");
zip.open(QuaZip::mdUnzip);
// first, we need some information about archive itself
QByteArray comment=zip.getComment();
// and now we are going to access files inside it
QuaZipFile file(&zip);
for(bool more=zip.goToFirstFile(); more; more=zip.goToNextFile()) {
file.open(QIODevice::ReadOnly);
// do something cool with file here
file.close(); // do not forget to close!
}
zip.close();
```

--------------------------------

### goToFirstFile

Source: https://stachenov.github.io/quazip/functions_g.html

Navigates the QuaZip archive to the first file entry. This is typically used when starting to iterate through the archive's contents.

```APIDOC
## goToFirstFile()

### Description
Navigates the QuaZip archive to the first file entry.

### Method
(Not specified, likely a member function)

### Endpoint
(Not applicable, SDK function)

### Parameters
None explicitly documented.

### Response
- **return value** (QuaZip) - Boolean indicating success or failure.

### Response Example
(Not provided)
```

--------------------------------

### QuaCompress Constructor

Source: https://stachenov.github.io/quazip/classQuaCompress.html

Constructs a QuaCompress instance. This is the starting point for using the fluent API.

```cpp
QuaCompress()
```

--------------------------------

### QuaZip Flatpak Manifest Configuration

Source: https://stachenov.github.io/quazip/usage.html

Example configuration for including QuaZip in a Flatpak YAML manifest. It specifies build system, build directory, configuration options, and sources.

```yaml
modules:
  - name: quazip
    buildsystem: cmake-ninja
    builddir: true
    config-opts:
      - -DCMAKE_BUILD_TYPE=MinSizeRel
    sources:
      - type: archive
        url: https://github.com/stachenov/quazip/archive/v1.1.tar.gz
        sha256: 54edce9c11371762bd4f0003c2937b5d8806a2752dd9c0fd9085e90792612ad0
      - type: shell
        commands:
          - sed -i 's|${CMAKE_ROOT}/Modules|share/cmake|' CMakeLists.txt
```

--------------------------------

### Find QuaZip with CMake

Source: https://stachenov.github.io/quazip/usage.html

Use this snippet in your CMakeLists.txt to find and link against the QuaZip library. Ensure QuaZip is installed or available in your CMake search path.

```cmake
find_package(QuaZip-Qt5)
target_link_libraries(whatever-your-target-is QuaZip::QuaZip)
```

--------------------------------

### Get Actual File Name in Archive

Source: https://stachenov.github.io/quazip/classQuaZipFile.html

Retrieves the real file name as it exists inside the ZIP archive. This can differ from the name provided during file setup, especially if case-insensitive matching was used. Returns a null string if no ZIP object is associated or no file is currently selected.

```cpp
QuaZipFile file("somezip.zip");
file.setFileName("somefile");
QString name=file.getName(); // name=="somefile"
QString actual=file.getActualFileName(); // actual is null string
file.open(QIODevice::ReadOnly);
QString actual=file.getActualFileName(); // actual can be "SoMeFiLe" on Windows
```

--------------------------------

### Initialize and Compress Directory with QuaCompress

Source: https://stachenov.github.io/quazip/classQuaCompress.html

Demonstrates fluent API usage for initializing QuaCompress, enabling UTF-8, setting compression to best, and compressing a directory.

```cpp
QuaCompress()
.withUtf8Enabled()
.withCompression(QuaCompress::Best)
.compressDir("archive.zip", "mydir/");
```

--------------------------------

### Construct QuaZipNewInfo from Existing File Info (64-bit)

Source: https://stachenov.github.io/quazip/structQuaZipNewInfo.html

Initializes a QuaZipNewInfo instance from an existing QuaZipFileInfo64 object. Similar to the non-64-bit version, this is used for copying files between archives, initializing extra fields from the existing info.

```cpp
QuaZipNewInfo(
    const QuaZipFileInfo64 & _existing_
)
```

--------------------------------

### Variables starting with 'i'

Source: https://stachenov.github.io/quazip/functions_vars.html

Variables related to internal attributes.

```APIDOC
### - i -
  * internalAttr : QuaZipFileInfo64, QuaZipFileInfo, QuaZipNewInfo
```

--------------------------------

### Variables starting with 'n'

Source: https://stachenov.github.io/quazip/functions_vars.html

Variables related to file names.

```APIDOC
### - n -
  * name : QuaZipFileInfo64, QuaZipFileInfo, QuaZipNewInfo
```

--------------------------------

### Variables starting with 'm'

Source: https://stachenov.github.io/quazip/functions_vars.html

Variables related to compression methods.

```APIDOC
### - m -
  * method : QuaZipFileInfo64, QuaZipFileInfo
```

--------------------------------

### QuaZipNewInfo()

Source: https://stachenov.github.io/quazip/functions_q.html

Constructor for QuaZipNewInfo. Initializes a new instance of the QuaZipNewInfo class.

```APIDOC
## QuaZipNewInfo()

### Description
Constructor for QuaZipNewInfo. Initializes a new instance of the QuaZipNewInfo class.

### Method
Constructor

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
None
```

--------------------------------

### QuaZipFile()

Source: https://stachenov.github.io/quazip/functions_q.html

Constructor for QuaZipFile. Initializes a new instance of the QuaZipFile class.

```APIDOC
## QuaZipFile()

### Description
Constructor for QuaZipFile. Initializes a new instance of the QuaZipFile class.

### Method
Constructor

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
None
```

--------------------------------

### Variables starting with 'f'

Source: https://stachenov.github.io/quazip/functions_vars.html

Variables related to file flags.

```APIDOC
### - f -
  * flags : QuaZipFileInfo64, QuaZipFileInfo
```

--------------------------------

### QuaZipNewInfo Constructors

Source: https://stachenov.github.io/quazip/structQuaZipNewInfo.html

Provides information on how to construct a QuaZipNewInfo object, including options for initializing with a name, file path, or existing file information.

```APIDOC
## QuaZipNewInfo()

### Description
Constructs QuaZipNewInfo instance.
Initializes name with _name_, dateTime with current date and time. Attributes are initialized with zeros, comment and extra field with null values.

### Signature
QuaZipNewInfo::QuaZipNewInfo(const QString &name)
```

```APIDOC
## QuaZipNewInfo()

### Description
Constructs QuaZipNewInfo instance.
Initializes name with _name_. Timestamp and permissions are taken from the specified file. If the _file_ does not exists or its timestamp is inaccessible (e. g. you do not have read permission for the directory file in), uses current time and zero permissions. Other attributes are initialized with zeros, comment and extra field with null values.

### Signature
QuaZipNewInfo::QuaZipNewInfo(const QString &name, const QString &file)
```

```APIDOC
## QuaZipNewInfo()

### Description
Constructs QuaZipNewInfo instance.

### Signature
QuaZipNewInfo::QuaZipNewInfo(const QString &name, const QString &file, const QDateTime &dateTime)
```

```APIDOC
## QuaZipNewInfo()

### Description
Initializes the new instance from existing file info.

### Signature
QuaZipNewInfo::QuaZipNewInfo(const QuaZipFileInfo &existing)
```

```APIDOC
## QuaZipNewInfo()

### Description
Initializes the new instance from existing file info.

### Signature
QuaZipNewInfo::QuaZipNewInfo(const QuaZipFileInfo64 &existing)
```

--------------------------------

### getFileNameCodec

Source: https://stachenov.github.io/quazip/functions_func_g.html

Gets the codec used for file names in the archive.

```APIDOC
## getFileNameCodec()

### Description
Gets the codec used for file names in the archive.

### Method
Not specified (likely a member function of QuaZip).

### Endpoint
N/A

### Parameters
None

### Request Example
N/A

### Response
#### Success Response
- **return value** (Unknown type, likely a codec object or string) - The file name codec.

### Response Example
N/A
```

--------------------------------

### Construct QuaZipNewInfo with Name and Timestamp

Source: https://stachenov.github.io/quazip/structQuaZipNewInfo.html

Initializes a QuaZipNewInfo instance with a name and a timestamp, deriving permissions from a specified file. If the file is inaccessible, zero permissions are used. Other attributes are initialized to zero.

```cpp
QuaZipNewInfo(
    const QString & _name_,
    const QString & _file_,
    const QDateTime & _dateTime_
)
```

--------------------------------

### getCommentCodec

Source: https://stachenov.github.io/quazip/functions_func_g.html

Gets the codec used for the archive's comment.

```APIDOC
## getCommentCodec()

### Description
Gets the codec used for the archive's comment.

### Method
Not specified (likely a member function of QuaZip).

### Endpoint
N/A

### Parameters
None

### Request Example
N/A

### Response
#### Success Response
- **return value** (Unknown type, likely a codec object or string) - The comment codec.

### Response Example
N/A
```

--------------------------------

### Open File for Reading (Basic)

Source: https://stachenov.github.io/quazip/classQuaZipFile.html

Opens the file for reading. Returns true on success, false on failure. The QIODevice::Unbuffered flag is not supported and will cause the open operation to fail.

```cpp
bool QuaZipFile::open(OpenMode _mode_)
```

--------------------------------

### getCaseSensitivity

Source: https://stachenov.github.io/quazip/functions_func_g.html

Gets the case sensitivity setting for the QuaZip archive.

```APIDOC
## getCaseSensitivity()

### Description
Gets the case sensitivity setting for the QuaZip archive.

### Method
Not specified (likely a member function of QuaZipFile).

### Endpoint
N/A

### Parameters
None

### Request Example
N/A

### Response
#### Success Response
- **return value** (Unknown type, likely an enum or boolean) - The case sensitivity setting.

### Response Example
N/A
```

--------------------------------

### Construct QuaZipNewInfo from Existing File Info

Source: https://stachenov.github.io/quazip/structQuaZipNewInfo.html

Initializes a QuaZipNewInfo instance from an existing QuaZipFileInfo object. This is primarily used when copying files between archives, and both extra fields are initialized from the existing info.

```cpp
QuaZipNewInfo(
    const QuaZipFileInfo & _existing_
)
```

--------------------------------

### open()

Source: https://stachenov.github.io/quazip/classQuaZIODevice.html

Opens the QuaZIODevice for reading or writing compressed data. Note that certain open modes are not supported.

```APIDOC
## open(QIODevice::OpenMode mode)

### Description
Opens the device for compressed data operations.

### Parameters
- **mode** (QIODevice::OpenMode) - The mode to open the device in. Note that QIODevice::ReadWrite and QIODevice::Append are not supported.

### Returns
- **bool** - True if the device was opened successfully, false otherwise.
```

--------------------------------

### Variables starting with 'c'

Source: https://stachenov.github.io/quazip/functions_vars.html

Variables related to compression and file information.

```APIDOC
## Variables

### - c -
  * comment : QuaZipFileInfo64, QuaZipFileInfo
  * compressedSize : QuaZipFileInfo64, QuaZipFileInfo
  * crc : QuaZipFileInfo64, QuaZipFileInfo
```

--------------------------------

### QuaZip Functions (s)

Source: https://stachenov.github.io/quazip/functions_func_s.html

Functions starting with 's' for various QuaZip classes.

```APIDOC
## setAutoClose()

### Description
Sets the auto-close behavior for QuaZip.

### Method
Not specified (likely a method call on a QuaZip object).

### Endpoint
N/A

### Parameters
None explicitly documented.

### Request Example
N/A

### Response
Returns a QuaZip object.

## setCaseSensitivity()

### Description
Sets the case sensitivity for QuaZipDir.

### Method
Not specified (likely a method call on a QuaZipDir object).

### Endpoint
N/A

### Parameters
None explicitly documented.

### Request Example
N/A

### Response
Returns a QuaZipDir object.

## setComment()

### Description
Sets the comment for the QuaZip archive.

### Method
Not specified (likely a method call on a QuaZip object).

### Endpoint
N/A

### Parameters
None explicitly documented.

### Request Example
N/A

### Response
Returns a QuaZip object.

## setCommentCodec()

### Description
Sets the codec for handling comments in QuaZip.

### Method
Not specified (likely a method call on a QuaZip object).

### Endpoint
N/A

### Parameters
None explicitly documented.

### Request Example
N/A

### Response
Returns a QuaZip object.

## setCurrentFile()

### Description
Sets the current file being processed by QuaZip.

### Method
Not specified (likely a method call on a QuaZip object).

### Endpoint
N/A

### Parameters
None explicitly documented.

### Request Example
N/A

### Response
Returns a QuaZip object.

## setDataDescriptorWritingEnabled()

### Description
Enables or disables the writing of data descriptors in QuaZip.

### Method
Not specified (likely a method call on a QuaZip object).

### Endpoint
N/A

### Parameters
None explicitly documented.

### Request Example
N/A

### Response
Returns a QuaZip object.

## setDefaultFileNameCodec()

### Description
Sets the default codec for file names in QuaZip.

### Method
Not specified (likely a method call on a QuaZip object).

### Endpoint
N/A

### Parameters
None explicitly documented.

### Request Example
N/A

### Response
Returns a QuaZip object.

## setDefaultOsCode()

### Description
Sets the default OS code for QuaZip.

### Method
Not specified (likely a method call on a QuaZip object).

### Endpoint
N/A

### Parameters
None explicitly documented.

### Request Example
N/A

### Response
Returns a QuaZip object.

## setFileDateTime()

### Description
Sets the date and time for a file within the QuaZip archive.

### Method
Not specified (likely a method call on a QuaZipNewInfo object).

### Endpoint
N/A

### Parameters
None explicitly documented.

### Request Example
N/A

### Response
N/A

## setFileName()

### Description
Sets the file name for a QuaZip entry.

### Method
Not specified (likely a method call on a QuaGzipFile or QuaZipFile object).

### Endpoint
N/A

### Parameters
None explicitly documented.

### Request Example
N/A

### Response
N/A

## setFileNameCodec()

### Description
Sets the codec for file names in QuaZip.

### Method
Not specified (likely a method call on a QuaZip object).

### Endpoint
N/A

### Parameters
None explicitly documented.

### Request Example
N/A

### Response
Returns a QuaZip object.

## setFileNTFSaTime()

### Description
Sets the Access Time (ATime) for a file using NTFS format.

### Method
Not specified (likely a method call on a QuaZipNewInfo object).

### Endpoint
N/A

### Parameters
None explicitly documented.

### Request Example
N/A

### Response
N/A

## setFileNTFScTime()

### Description
Sets the Creation Time (CTime) for a file using NTFS format.

### Method
Not specified (likely a method call on a QuaZipNewInfo object).

### Endpoint
N/A

### Parameters
None explicitly documented.

### Request Example
N/A

### Response
N/A

## setFileNTFSmTime()

### Description
Sets the Modification Time (MTime) for a file using NTFS format.

### Method
Not specified (likely a method call on a QuaZipNewInfo object).

### Endpoint
N/A

### Parameters
None explicitly documented.

### Request Example
N/A

### Response
N/A

## setFileNTFSTimes()

### Description
Sets all NTFS times (Access, Creation, Modification) for a file.

### Method
Not specified (likely a method call on a QuaZipNewInfo object).

### Endpoint
N/A

### Parameters
None explicitly documented.

### Request Example
N/A

### Response
N/A

## setFilePermissions()

### Description
Sets the file permissions for a QuaZip entry.

### Method
Not specified (likely a method call on a QuaZipNewInfo object).

### Endpoint
N/A

### Parameters
None explicitly documented.

### Request Example
N/A

### Response
N/A

## setFilter()

### Description
Sets a filter for QuaZipDir.

### Method
Not specified (likely a method call on a QuaZipDir object).

### Endpoint
N/A

### Parameters
None explicitly documented.

### Request Example
N/A

### Response
Returns a QuaZipDir object.

## setIoDevice()

### Description
Sets the I/O device for QuaZip.

### Method
Not specified (likely a method call on a QuaZip object).

### Endpoint
N/A

### Parameters
None explicitly documented.

### Request Example
N/A

### Response
Returns a QuaZip object.

## setNameFilters()

### Description
Sets name filters for QuaZipDir.

### Method
Not specified (likely a method call on a QuaZipDir object).

### Endpoint
N/A

### Parameters
None explicitly documented.

### Request Example
N/A

### Response
Returns a QuaZipDir object.

## setOsCode()

### Description
Sets the OS code for QuaZip.

### Method
Not specified (likely a method call on a QuaZip object).

### Endpoint
N/A

### Parameters
None explicitly documented.

### Request Example
N/A

### Response
Returns a QuaZip object.

## setPath()

### Description
Sets the path for QuaZipDir.

### Method
Not specified (likely a method call on a QuaZipDir object).

### Endpoint
N/A

### Parameters
None explicitly documented.

### Request Example
N/A

### Response
Returns a QuaZipDir object.

## setPermissions()

### Description
Sets the file permissions for a QuaZip entry.

### Method
Not specified (likely a method call on a QuaZipNewInfo object).

### Endpoint
N/A

### Parameters
None explicitly documented.

### Request Example
N/A

### Response
N/A

## setSorting()

### Description
Sets the sorting mode for QuaZipDir.

### Method
Not specified (likely a method call on a QuaZipDir object).

### Endpoint
N/A

### Parameters
None explicitly documented.

### Request Example
N/A

### Response
Returns a QuaZipDir object.

## setUtf8Enabled()

### Description
Enables or disables UTF-8 encoding for file names in QuaZip.

### Method
Not specified (likely a method call on a QuaZip object).

### Endpoint
N/A

### Parameters
None explicitly documented.

### Request Example
N/A

### Response
Returns a QuaZip object.

## setZip()

### Description
Sets the zip file for QuaZipFile.

### Method
Not specified (likely a method call on a QuaZipFile object).

### Endpoint
N/A

### Parameters
None explicitly documented.

### Request Example
N/A

### Response
N/A

## setZip64Enabled()

### Description
Enables or disables ZIP64 extensions for QuaZip.

### Method
Not specified (likely a method call on a QuaZip object).

### Endpoint
N/A

### Parameters
None explicitly documented.

### Request Example
N/A

### Response
Returns a QuaZip object.

## setZipName()

### Description
Sets the name of the zip file for QuaZip or QuaZipFile.

### Method
Not specified (likely a method call on a QuaZip or QuaZipFile object).

### Endpoint
N/A

### Parameters
None explicitly documented.

### Request Example
N/A

### Response
N/A

## size()

### Description
Returns the size of the QuaZip file.

### Method
Not specified (likely a method call on a QuaZipFile object).

### Endpoint
N/A

### Parameters
None explicitly documented.

### Request Example
N/A

### Response
Returns the size of the file (likely an integer or long).

## sorting()

### Description
Returns the sorting mode of QuaZipDir.

### Method
Not specified (likely a method call on a QuaZipDir object).

### Endpoint
N/A

### Parameters
None explicitly documented.

### Request Example
N/A

### Response
Returns the sorting mode (type not specified).
```

--------------------------------

### QuaZIODevice Public Methods

Source: https://stachenov.github.io/quazip/quaziodevice_8h_source.html

Provides essential methods for managing the compressed I/O device.

```APIDOC
## QuaZIODevice Public Methods

### Description
These methods allow for flushing data, opening and closing the device, retrieving the underlying QIODevice, and checking its status.

### Methods
- **virtual bool flush()**: Flushes any buffered data to the underlying device.
- **bool open(QIODevice::OpenMode mode) override**: Opens the device with the specified mode.
- **void close() override**: Closes the device.
- **QIODevice *getIoDevice() const**: Returns a pointer to the underlying QIODevice.
- **bool isSequential() const override**: Checks if the device is sequential.
- **bool atEnd() const override**: Checks if the end of the device has been reached.
- **qint64 bytesAvailable() const override**: Returns the number of bytes available for reading.
```

--------------------------------

### QuaZipFile::QuaZipFile() [1/5]

Source: https://stachenov.github.io/quazip/classQuaZipFile.html

Constructs a QuaZipFile instance. You should use setZipName() and setFileName() or setZip() before calling open().

```APIDOC
## QuaZipFile()

### Description
Constructs a QuaZipFile instance.

You should use `setZipName()` and `setFileName()` or `setZip()` before trying to call `open()` on the constructed object.
```

--------------------------------

### getCurrentFileName

Source: https://stachenov.github.io/quazip/functions_func_g.html

Gets the name of the current file entry in the QuaZip archive.

```APIDOC
## getCurrentFileName()

### Description
Gets the name of the current file entry in the QuaZip archive.

### Method
Not specified (likely a member function of QuaZip).

### Endpoint
N/A

### Parameters
None

### Request Example
N/A

### Response
#### Success Response
- **return value** (string) - The name of the current file entry.

### Response Example
N/A
```

--------------------------------

### QuaZipNewInfo Constructors

Source: https://stachenov.github.io/quazip/structQuaZipNewInfo.html

Provides documentation for the different constructors of the QuaZipNewInfo class, used to initialize file information for ZIP archives.

```APIDOC
## ◆ QuaZipNewInfo()

### Description
Constructs QuaZipNewInfo instance. Initializes name with _name_ and provided timestamp. Permissions are taken from the specified file. If the _file_ does not exists or is inaccessible (e. g. you do not have read permission for the directory file in), uses zero permissions. Other attributes are initialized with zeros, comment and extra field with null values.

### Parameters
* `_name_` (const QString &) - The name of the file in the archive.
* `_file_` (const QString &) - The path to the file from which to take permissions and timestamp.
* `_dateTime_` (const QDateTime &) - The timestamp to set for the file.

### See also
setFileDateTime()
```

```APIDOC
## ◆ QuaZipNewInfo()

### Description
Initializes the new instance from existing file info. Mainly used when copying files between archives. Both extra fields are initialized to existing.extra.

### Parameters
* `existing` (const QuaZipFileInfo &) - The existing file info to copy from.
```

```APIDOC
## ◆ QuaZipNewInfo()

### Description
Initializes the new instance from existing file info. Mainly used when copying files between archives. Both extra fields are initialized to existing.extra.

### Parameters
* `existing` (const QuaZipFileInfo64 &) - The existing file info to copy from.
```

--------------------------------

### Variables starting with 'z'

Source: https://stachenov.github.io/quazip/functions_vars.html

Variables related to internal zip file pointers.

```APIDOC
### - z -
  * zipFile_f : QuaZipPrivate
```

--------------------------------

### Variables starting with 'd'

Source: https://stachenov.github.io/quazip/functions_vars.html

Variables related to file timestamps and disk information.

```APIDOC
### - d -
  * dateTime : QuaZipFileInfo64, QuaZipFileInfo, QuaZipNewInfo
  * diskNumberStart : QuaZipFileInfo64, QuaZipFileInfo
```

--------------------------------

### open

Source: https://stachenov.github.io/quazip/classQuaZIODevice-members.html

Opens the device in the specified mode.

```APIDOC
## open

### Description
Opens the device in the specified mode.

### Method
override

### Parameters
#### Path Parameters
- **mode** (QIODevice::OpenMode) - Required - The mode to open the device in.

### Signature
`bool open(QIODevice::OpenMode mode) override`
```

--------------------------------

### pos

Source: https://stachenov.github.io/quazip/functions_p.html

Gets the current position within the file. Returns the position as an integer.

```APIDOC
## pos()

### Description
Gets the current position within the file.

### Method
This is a function call.

### Returns
- integer: The current position in the file.
```

--------------------------------

### Run QuaZip Test Suite

Source: https://stachenov.github.io/quazip/index.html

Execute the test suite for QuaZip using 'ctest'. The --verbose flag provides detailed output, and -C Release specifies the build configuration. Ensure your environment variables (PATH, LD_LIBRARY_PATH, SHLIB_PATH) are set correctly if 'qztest' has issues running.

```bash
ctest --verbose -C Release
```

--------------------------------

### pos

Source: https://stachenov.github.io/quazip/functions_func_p.html

Gets the current position within the file. Associated with the QuaZipFile class.

```APIDOC
## pos()

### Description
Gets the current position within the file.

### Class
QuaZipFile

### Returns
- qint64: The current position in the file.
```

--------------------------------

### Variables starting with 'v'

Source: https://stachenov.github.io/quazip/functions_vars.html

Variables related to version information for created and needed files.

```APIDOC
### - v -
  * versionCreated : QuaZipFileInfo64, QuaZipFileInfo
  * versionNeeded : QuaZipFileInfo64, QuaZipFileInfo
```

--------------------------------

### QuaZipFile Setting Methods

Source: https://stachenov.github.io/quazip/quazipfile_8h_source.html

Methods to configure QuaZipFile properties.

```APIDOC
## void setZipName(const QString& zipName)

### Description
Sets the name of the ZIP archive.

### Method
setZipName

### Endpoint
N/A

### Parameters
- **zipName** (QString) - The name of the ZIP archive.

### Request Example
None

### Response
None
```

```APIDOC
## void setZip(QuaZip *zip)

### Description
Sets the QuaZip object associated with this file.

### Method
setZip

### Endpoint
N/A

### Parameters
- **zip** (QuaZip *) - A pointer to the QuaZip object.

### Request Example
None

### Response
None
```

```APIDOC
## void setFileName(const QString& fileName, QuaZip::CaseSensitivity cs = QuaZip::csDefault)

### Description
Sets the name of the file within the ZIP archive and its case sensitivity.

### Method
setFileName

### Endpoint
N/A

### Parameters
- **fileName** (QString) - The name of the file within the ZIP archive.
- **cs** (QuaZip::CaseSensitivity) - The case sensitivity setting (default is QuaZip::csDefault).

### Request Example
None

### Response
None
```

--------------------------------

### toQuaZipFileInfo()

Source: https://stachenov.github.io/quazip/functions_func_t.html

Converts the current state to a QuaZipFileInfo64 object.

```APIDOC
## toQuaZipFileInfo()

### Description
Converts the current state to a QuaZipFileInfo64 object, providing detailed information about the archive entry.

### Method
This is a function call within the QuaZip library.

### Parameters
This function does not take any explicit parameters.

### Response
- **QuaZipFileInfo64**: An object containing file information such as compression method, original and compressed size, CRC, etc.
```

--------------------------------

### Variables starting with 'u'

Source: https://stachenov.github.io/quazip/functions_vars.html

Variables related to uncompressed sizes and internal file pointers.

```APIDOC
### - u -
  * uncompressedSize : QuaZipFileInfo64, QuaZipFileInfo, QuaZipNewInfo
  * unzFile_f : QuaZipPrivate
```

--------------------------------

### Open File with Advanced Options

Source: https://stachenov.github.io/quazip/classQuaZipFile.html

Opens a file for reading with advanced options including compression method, level, raw mode, and password. The integers pointed to by _method_ and _level_ will receive the compression codes. If raw is true, no decompression is performed. _method_ must not be NULL, while _level_ can be NULL.

```cpp
bool QuaZipFile::open(OpenMode _mode_, int * _method_, int * _level_, bool _raw_, const char * _password_ = nullptr)
```

--------------------------------

### Variables starting with 'e'

Source: https://stachenov.github.io/quazip/functions_vars.html

Variables related to external attributes and extra data fields.

```APIDOC
### - e -
  * externalAttr : QuaZipFileInfo64, QuaZipFileInfo, QuaZipNewInfo
  * extra : QuaZipFileInfo64, QuaZipFileInfo
  * extraGlobal : QuaZipNewInfo
  * extraLocal : QuaZipNewInfo
```

--------------------------------

### Build QuaZip Library with CMake

Source: https://stachenov.github.io/quazip/index.html

Use this command to configure and build the QuaZip library. Specify the Qt major version (5 or 6) using the QUAZIP_QT_MAJOR_VERSION flag. The build directory can be specified with -B.

```bash
cd /wherever/quazip/source/is/quazip-x.y.z
cmake -B wherever/you/want/your/build/to/be -D QUAZIP_QT_MAJOR_VERSION=6 or 5
cmake --build wherever/you/want/your/build/to/be
```

--------------------------------

### QuaZIODevice Constructor

Source: https://stachenov.github.io/quazip/classQuaZIODevice.html

Initializes a QuaZIODevice with an underlying QIODevice and an optional parent object.

```APIDOC
## QuaZIODevice()

### Description
Constructor for QuaZIODevice.

### Parameters
- **io** (QIODevice *) - The QIODevice to read/write compressed data from/to.
- **parent** (QObject *) - Optional parent object for QObject management.
```

--------------------------------

### Global Archive Comment

Source: https://stachenov.github.io/quazip/classQuaZip.html

Functions to get and set the global comment for the ZIP archive.

```APIDOC
## QString getComment () const

### Description
Returns global comment in the ZIP file.

### Method
getComment

### Returns
- **QString** - The global comment of the ZIP file.
```

```APIDOC
## void setComment (const QString &comment)

### Description
Sets the global comment in the ZIP file.

### Method
setComment

### Parameters
#### Path Parameters
- **comment** (const QString &) - Required - The global comment to set for the ZIP file.
```

--------------------------------

### QuaZIODevice

Source: https://stachenov.github.io/quazip/classQuaZIODevice-members.html

Constructor for QuaZIODevice.

```APIDOC
## QuaZIODevice

### Description
Constructor for QuaZIODevice.

### Parameters
#### Path Parameters
- **io** (QIODevice *) - Required - The underlying I/O device.
- **parent** (QObject *) - Optional - The parent object.

### Signature
`QuaZIODevice(QIODevice *io, QObject *parent=nullptr)`
```

--------------------------------

### QuaCompress Constructor

Source: https://stachenov.github.io/quazip/classQuaCompress.html

Constructs a new QuaCompress instance. This is the starting point for building compression operations.

```APIDOC
## QuaCompress()

### Description
Construct a QuaCompress instance.

### Definition
QuaCompress.cpp:34
```

--------------------------------

### Archive Name and Device

Source: https://stachenov.github.io/quazip/classQuaZip.html

Functions to get and set the name of the ZIP file and the associated QIODevice.

```APIDOC
## QString getZipName () const

### Description
Returns the name of the ZIP file.

### Method
getZipName

### Returns
- **QString** - The name of the ZIP file.
```

```APIDOC
## void setZipName (const QString &zipName)

### Description
Sets the name of the ZIP file.

### Method
setZipName

### Parameters
#### Path Parameters
- **zipName** (const QString &) - Required - The new name for the ZIP file.
```

```APIDOC
## QIODevice * getIoDevice () const

### Description
Returns the device representing this ZIP file.

### Method
getIoDevice

### Returns
- **QIODevice *** - The QIODevice associated with the ZIP file.
```

```APIDOC
## void setIoDevice (QIODevice *ioDevice)

### Description
Sets the device representing the ZIP file.

### Method
setIoDevice

### Parameters
#### Path Parameters
- **ioDevice** (QIODevice *) - Required - The new QIODevice to represent the ZIP file.
```

--------------------------------

### entryInfoList() [1/2]

Source: https://stachenov.github.io/quazip/classQuaZipDir.html

Returns a list of QuaZipFileInfo for entries in the current directory, filtered and sorted according to the provided parameters.

```APIDOC
## entryInfoList(const QStringList &nameFilters, QDir::Filters filters, QDir::SortFlags sort)

### Description
Returns the list of the entries in the directory with specified name filters, entry type filters, and sorting mode.

### Parameters
* **nameFilters** (const QStringList &) - The list of file patterns to list, uses the same syntax as QDir.
* **filters** (QDir::Filters) - The entry type filters, only Files and Dirs are accepted. Defaults to `QDir::NoFilter`.
* **sort** (QDir::SortFlags) - Sorting mode. Defaults to `QDir::NoSort`.

### Returns
`QList<QuaZipFileInfo>` - A list of QuaZipFileInfo objects for the matching entries.
```

--------------------------------

### entryInfoList() [2/2]

Source: https://stachenov.github.io/quazip/classQuaZipDir.html

Returns a list of QuaZipFileInfo for entries in the current directory, filtered and sorted according to the provided parameters.

```APIDOC
## entryInfoList(QDir::Filters filters, QDir::SortFlags sort)

### Description
Returns the list of the entries in the directory with specified entry type filters and sorting mode. This is an overloaded member function for convenience.

### Parameters
* **filters** (QDir::Filters) - The entry type filters, only Files and Dirs are accepted. Defaults to `QDir::NoFilter`.
* **sort** (QDir::SortFlags) - Sorting mode. Defaults to `QDir::NoSort`.

### Returns
`QList<QuaZipFileInfo>` - A list of QuaZipFileInfo objects for the matching entries.
```

--------------------------------

### getCommentCodec

Source: https://stachenov.github.io/quazip/functions_g.html

Gets the codec used for the comment in a QuaZip archive. This is important for correctly interpreting the comment string.

```APIDOC
## getCommentCodec()

### Description
Gets the codec used for the comment in a QuaZip archive.

### Method
(Not specified, likely a member function)

### Endpoint
(Not applicable, SDK function)

### Parameters
None explicitly documented.

### Response
- **return value** (QuaZip) - The comment codec.

### Response Example
(Not provided)
```

--------------------------------

### QuaZip::open()

Source: https://stachenov.github.io/quazip/classQuaZip.html

Opens a ZIP file with a specified mode and optional I/O API. It handles device management and error reporting.

```APIDOC
## open()

### Description
Opens a ZIP file. The `_mode_` argument specifies the open mode of the ZIP archive. If a `QIODevice` is explicitly set, QuaZip checks for mode compatibility and performs seeking if necessary. The `_ioApi_` argument specifies the I/O function set for the ZIP/UNZIP package, with a default API that delegates to `QIODevice`.

### Method
bool QuaZip::open(Mode _mode_, zlib_filefunc_def *_ioApi_ = nullptr)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```
// Example usage (conceptual, actual parameters depend on Mode enum)
QuaZip zip("archive.zip");
if (zip.open(QuaZip::mdCreate)) {
    // ... operations ...
    zip.close();
}
```

### Response
#### Success Response (true)
Returns `true` if the ZIP file was opened successfully.

#### Error Response (false)
Returns `false` if the ZIP file could not be opened. Use `getZipError()` to retrieve the error code.

#### Response Example
```
true
```
```

--------------------------------

### Constructing QuaZipFile with an Existing QuaZip Object

Source: https://stachenov.github.io/quazip/classQuaZipFile.html

Use this constructor when you have an existing QuaZip object and want to operate on one of its files. Be cautious when changing the current file in the QuaZip object while a QuaZipFile is open, as it can lead to invalid states.

```cpp
QuaZip zip("archive.zip");
zip.open(QuaZip::mdUnzip);
QuaZipFile file(&zip);
file.open(QIODevice::ReadOnly);
```

--------------------------------

### getCaseSensitivity

Source: https://stachenov.github.io/quazip/functions_g.html

Gets the case sensitivity setting for a QuaZipFile. This helps in determining how file name comparisons are handled.

```APIDOC
## getCaseSensitivity()

### Description
Gets the case sensitivity setting for a QuaZipFile.

### Method
(Not specified, likely a member function)

### Endpoint
(Not applicable, SDK function)

### Parameters
None explicitly documented.

### Response
- **return value** (QuaZipFile) - The case sensitivity setting.

### Response Example
(Not provided)
```

--------------------------------

### cd()

Source: https://stachenov.github.io/quazip/classQuaZipDir.html

Changes the current directory within the ZIP archive. Paths starting with '/' are absolute, others are relative.

```APIDOC
## cd()

### Description
Changes the 'current' directory within the ZIP archive. If the path starts with '/', it is interpreted as an absolute path from the root of the archive. Otherwise, it is interpreted as a path relative to the current directory.

### Parameters
* **_dirName_** (const QString &) - The name of the directory to change to.

### Returns
`bool` - `true` if the directory change was successful, `false` otherwise.
```
Tokens:
Raw