Skip to content

minizip Module#

Miz archive helpers. Use with require("minizip").

Functions#

unzClose#

Closes a miz file.

minizip.unzClose()

unzGetCurrentFileName#

Returns the current file name while iterating a miz file.

filename = minizip.unzGetCurrentFileName()

unzGoToFirstFile#

Sets the iterator to the first file in the miz.

minizip.unzGoToFirstFile()

unzGoToNextFile#

Sets the iterator to the next file in the miz.

found = minizip.unzGoToNextFile()
Return Type Description
found boolean false when there are no more files.

unzLocateFile#

Locates a file in the miz and sets the iterator to it.

found = minizip.unzLocateFile(filename)
Parameter Type Required Description
filename string Yes File to locate inside the miz.
Return Type Description
found boolean false if not found.

unzOpen#

Opens a miz.

archive = minizip.unzOpen(filename, mode)

Note

Mode "rb" is known. It is unclear whether "w" works.

unzReadAllCurrentFile#

Returns the content of the current file.

content = minizip.unzReadAllCurrentFile()

unzUnpackCurrentFile#

Unpacks the current file to a path.

ok = minizip.unzUnpackCurrentFile(path)
Return Type Description
ok boolean true on success.

zipAddFile#

Adds a file from disk to the miz.

ok = minizip.zipAddFile(fileInMiz, path)
Parameter Type Required Description
fileInMiz string Yes Destination path inside the miz.
path string Yes Source path on disk.
Return Type Description
ok boolean true on success.

zipAppend#

Unknown.

minizip.zipAppend(...)

zipClose#

Closes a miz file.

minizip.zipClose()

zipCreate#

Creates a miz.

archive = minizip.zipCreate(filename)
Return Type Description
archive minizip Created miz archive handle.