LibArchiveArchive Class | Qt Installer Framework Manual

- Qt Installer Framework Manual
- LibArchiveArchive

# LibArchiveArchive Class

(QInstaller::LibArchiveArchive)

The LibArchiveArchive class represents an archive file handled with libarchive archive and compression library. More...

Header: | #include <LibArchiveArchive>
Inherits: | QInstaller::AbstractArchive

- List of all members, including inherited members

## Public Functions

| LibArchiveArchive(const QString &filename, QObject *parent = nullptr)
| LibArchiveArchive(QObject *parent = nullptr)
virtual | ~LibArchiveArchive()
void | workerAddDataBlock(const QByteArray buffer)
void | workerCancel()
void | workerExtract(const QString &dirPath, const quint64 totalFiles)
void | workerSetDataAtEnd()
void | workerSetFilePosition(qint64 pos)
ExtractWorker::Status | workerStatus() const

## Reimplemented Public Functions

virtual void | close() override
virtual bool | create(const QStringList &data) override
virtual bool | extract(const QString &dirPath) override
virtual bool | extract(const QString &dirPath, const quint64 totalFiles) override
virtual bool | isSupported() override
virtual QVector<QInstaller::ArchiveEntry> | list() override
virtual bool | open(QIODevice::OpenMode mode) override
virtual void | setFilename(const QString &filename) override

- 10 public functions inherited from QInstaller::AbstractArchive

## Public Slots

virtual void | cancel() override

- 1 public slot inherited from QInstaller::AbstractArchive

## Signals

void | dataBlockRequested()
void | seekRequested(qint64 offset, int whence)
void | workerAboutToAddDataBlock(const QByteArray buffer)
void | workerAboutToCancel()
void | workerAboutToExtract(const QString &dirPath, const quint64 totalFiles)
void | workerAboutToSetDataAtEnd()
void | workerAboutToSetFilePosition(qint64 pos)
void | workerFinished()

- 2 signals inherited from QInstaller::AbstractArchive

## Static Public Members

const QMetaObject | staticMetaObject

### Additional Inherited Members

- 2 protected functions inherited from QInstaller::AbstractArchive

## Detailed Description

The LibArchiveArchive class represents an archive file handled with libarchive archive and compression library.

In addition to extracting data from the underlying file device, the class supports a non-blocking mode of extracting from an external data source. When using this mode, the calling client must pass the data to be read in chunks of arbitrary size, and inform the object when there is no more data to read.

## Member Function Documentation

### LibArchiveArchive::LibArchiveArchive(const QString &filename, QObject *parent = nullptr)

Default constructs an instance of LibArchiveArchive.

### LibArchiveArchive::LibArchiveArchive(QObject *parent = nullptr)

Default constructs an instance of LibArchiveArchive.

### `[virtual]` LibArchiveArchive::~LibArchiveArchive()

Destroys the instance of LibArchiveArchive. The destructor is virtual.

### `[override virtual slot]` void LibArchiveArchive::cancel()

### `[override virtual]` void LibArchiveArchive::close()

### `[override virtual]` bool LibArchiveArchive::create(const QStringList &data)

### `[signal]` void LibArchiveArchive::dataBlockRequested()

### `[override virtual]` bool LibArchiveArchive::extract(const QString &dirPath)

### `[override virtual]` bool LibArchiveArchive::extract(const QString &dirPath, const quint64 totalFiles)

### `[override virtual]` bool LibArchiveArchive::isSupported()

### `[override virtual]` QVector<QInstaller::ArchiveEntry> LibArchiveArchive::list()

### `[override virtual]` bool LibArchiveArchive::open(QIODevice::OpenMode mode)

### `[signal]` void LibArchiveArchive::seekRequested(qint64 offset, int whence)

### `[override virtual]` void LibArchiveArchive::setFilename(const QString &filename)

### `[signal]` void LibArchiveArchive::workerAboutToAddDataBlock(const QByteArray buffer)

### `[signal]` void LibArchiveArchive::workerAboutToCancel()

### `[signal]` void LibArchiveArchive::workerAboutToExtract(const QString &dirPath, const quint64 totalFiles)

### `[signal]` void LibArchiveArchive::workerAboutToSetDataAtEnd()

### `[signal]` void LibArchiveArchive::workerAboutToSetFilePosition(qint64 pos)

### void LibArchiveArchive::workerAddDataBlock(const QByteArray buffer)

### void LibArchiveArchive::workerCancel()

### void LibArchiveArchive::workerExtract(const QString &dirPath, const quint64 totalFiles)

### `[signal]` void LibArchiveArchive::workerFinished()

### void LibArchiveArchive::workerSetDataAtEnd()

### void LibArchiveArchive::workerSetFilePosition(qint64 pos)

### ExtractWorker::Status LibArchiveArchive::workerStatus() const