ZipFile

#include <icy/archo/zipfile.h>

struct ZipFile

Defined in src/archo/include/icy/archo/zipfile.h:36

Public Attributes

Return	Name	Description
std::vector< `FileInfo` >	`info`
`unzFile`	`fp`
`uint64_t`	`_totalWritten`
`uint64_t`	`_entriesExtracted`

info

std::vector< FileInfo > info

Type: std::vector< FileInfo >

Defined in src/archo/include/icy/archo/zipfile.h:105

fp

unzFile fp

Defined in src/archo/include/icy/archo/zipfile.h:106

_totalWritten

uint64_t _totalWritten = 0

Defined in src/archo/include/icy/archo/zipfile.h:107

_entriesExtracted

uint64_t _entriesExtracted = 0

Defined in src/archo/include/icy/archo/zipfile.h:108

Public Methods

Return	Name	Description
	`ZipFile`	Constructs an unopened ZipFile. Call open() before use.
	`ZipFile` explicit	Constructs a ZipFile and immediately opens the archive at `file`.
	`~ZipFile`	Closes the archive if still open.
	`ZipFile`	Deleted constructor.
`ZipFile` &	`operator=`	Deleted assignment operator.
	`ZipFile`	Deleted constructor.
`ZipFile` &	`operator=`	Deleted assignment operator.
`void`	`open`	Opens the archive at `file`, closing any previously opened archive. Populates the `info` vector with metadata for every entry.
`bool`	`opened` const	Returns true if the archive is currently open.
`void`	`close`	Closes the archive and releases the underlying file handle.
`void`	`extract`	Extracts the archive contents to the given directory path.
`bool`	`extractCurrentFile`	Extracts the current file entry to `path`. Validates each entry against path-traversal attacks before writing.
`bool`	`goToFirstFile`	Moves the internal cursor to the first file entry in the archive.
`bool`	`goToNextFile`	Advances the internal cursor to the next file entry.
`void`	`openCurrentFile`	Opens the current file entry for reading.
`void`	`closeCurrentFile`	Closes the current file entry.
`std::string`	`currentFileName`	Returns the name (relative path) of the current file entry.

ZipFile()

Defined in src/archo/include/icy/archo/zipfile.h:39

Constructs an unopened ZipFile. Call open() before use.

ZipFile

explicit

explicit ZipFile(const std::filesystem::path & file)

Defined in src/archo/include/icy/archo/zipfile.h:43

Constructs a ZipFile and immediately opens the archive at file.

Parameters

Parameter	Type	Description
`file`	`const std::filesystem::path &`	Path to the ZIP archive to open.

~ZipFile

~ZipFile()

Defined in src/archo/include/icy/archo/zipfile.h:46

Closes the archive if still open.

ZipFile

ZipFile(const ZipFile &) = delete

Defined in src/archo/include/icy/archo/zipfile.h:48

Deleted constructor.

operator=

ZipFile & operator=(const ZipFile &) = delete

Defined in src/archo/include/icy/archo/zipfile.h:49

Deleted assignment operator.

ZipFile

ZipFile(ZipFile &&) = delete

Defined in src/archo/include/icy/archo/zipfile.h:50

Deleted constructor.

operator=

ZipFile & operator=(ZipFile &&) = delete

Defined in src/archo/include/icy/archo/zipfile.h:51

Deleted assignment operator.

open

void open(const std::filesystem::path & file)

Defined in src/archo/include/icy/archo/zipfile.h:57

Opens the archive at file, closing any previously opened archive. Populates the info vector with metadata for every entry.

Parameters

Parameter	Type	Description
`file`	`const std::filesystem::path &`	Path to the ZIP archive.

Exceptions

Exception	Description
`std::runtime_error`	if the file cannot be opened.

opened

const

bool opened() const

Defined in src/archo/include/icy/archo/zipfile.h:60

Returns true if the archive is currently open.

close

void close()

Defined in src/archo/include/icy/archo/zipfile.h:63

Closes the archive and releases the underlying file handle.

extract

void extract(const std::filesystem::path & path)

Defined in src/archo/include/icy/archo/zipfile.h:68

Extracts the archive contents to the given directory path.

Parameters

Parameter	Type	Description
`path`	`const std::filesystem::path &`	Destination directory; created automatically if necessary.

Exceptions

Exception	Description
`std::runtime_error`	if the archive is not open or a read error occurs.

extractCurrentFile

bool extractCurrentFile(const std::filesystem::path & path, bool whiny = true)

Defined in src/archo/include/icy/archo/zipfile.h:75

Extracts the current file entry to path. Validates each entry against path-traversal attacks before writing.

Returns

true on success, false if whiny is false and an error occurred.

Parameters

Parameter	Type	Description
`path`	`const std::filesystem::path &`	Destination base directory.
`whiny`	`bool`	If true, re-throws on error; otherwise returns false.

goToFirstFile

bool goToFirstFile()

Defined in src/archo/include/icy/archo/zipfile.h:79

Moves the internal cursor to the first file entry in the archive.

Returns

true on success, false if the archive is empty or an error occurred.

goToNextFile

bool goToNextFile()

Defined in src/archo/include/icy/archo/zipfile.h:83

Advances the internal cursor to the next file entry.

Returns

true if another entry exists, false at end-of-list.

openCurrentFile

void openCurrentFile()

Defined in src/archo/include/icy/archo/zipfile.h:87

Opens the current file entry for reading.

Exceptions

Exception	Description
`std::runtime_error`	on failure.

closeCurrentFile

void closeCurrentFile()

Defined in src/archo/include/icy/archo/zipfile.h:91

Closes the current file entry.

Exceptions

Exception	Description
`std::runtime_error`	on failure.

currentFileName

std::string currentFileName()

Defined in src/archo/include/icy/archo/zipfile.h:95

Returns the name (relative path) of the current file entry.

Returns

Entry name as reported by the ZIP directory.