GHC 9.14.1 · lts/ghc-9.14.x · 6d5fdfd · 2026-10-12
Modulezip-archive-0.5Haskell2010
The zip-archive library provides functions for creating, modifying, and extracting files from zip archives.
Certain simplifying assumptions are made about the zip archives: in particular, there is no support for strong encryption, zip files that span multiple disks, ZIP64, OS-specific file attributes, or compression methods other than Deflate. However, the library should be able to read the most common zip archives, and the archives it produces should be readable by all standard unzip programs.
One known limitation: when parsing an archive whose local file
headers defer sizes to a data descriptor (general purpose bit 3)
and whose entries are stored without compression, the end of the
entry data can only be found by scanning for the optional data
descriptor signature 0x08074b50. Parsing such an archive can
therefore fail (or truncate an entry) if that byte sequence occurs
within the stored data itself. Archives of this kind are rare;
deflated entries with data descriptors are not affected.
As an example of the use of the library, a standalone zip archiver and extractor, Zip.hs, is provided in the source distribution.
For more information on the format of zip archives, consult http://www.pkware.com/documents/casestudies/APPNOTE.TXT
Structured representation of a zip archive, including directory information and contents (in lazy bytestrings).
ArchivezEntries :: [Entry]Files in zip archive
zSignature :: Maybe ByteStringDigital signature
zComment :: !ByteStringComment for whole zip archive
Representation of an archived file, including content and metadata.
EntryeRelativePath :: FilePathRelative path, using / as separator
eCompressionMethod :: !CompressionMethodCompression method
eEncryptionMethod :: !EncryptionMethodEncryption method
eLastModified :: !IntegerModification time (seconds since unix epoch, shifted by the local time zone offset: MSDOS timestamps in zip archives are conventionally local time)
eCRC32 :: !Word32CRC32 checksum
eCompressedSize :: !Word32Compressed size in bytes
eUncompressedSize :: !Word32Uncompressed size in bytes
eExtraField :: !ByteStringExtra field - unused by this library
eFileComment :: !ByteStringFile comment - unused by this library
eVersionMadeBy :: !Word16Version made by field
eInternalFileAttributes :: !Word16Internal file attributes - unused by this library
eExternalFileAttributes :: !Word32External file attributes (system-dependent)
eCompressedData :: !ByteStringCompressed contents of file
Compression methods.
Eq CompressionMethodDefined in zip-archive-0.5 · Codec.Archive.ZipRead CompressionMethodDefined in zip-archive-0.5 · Codec.Archive.ZipShow CompressionMethodDefined in zip-archive-0.5 · Codec.Archive.ZipNoEncryptionEntry is not encrypted
PKWAREEncryption !Word8Entry is encrypted with the traditional PKWARE encryption
Eq EncryptionMethodDefined in zip-archive-0.5 · Codec.Archive.ZipRead EncryptionMethodDefined in zip-archive-0.5 · Codec.Archive.ZipShow EncryptionMethodDefined in zip-archive-0.5 · Codec.Archive.ZipOptions for addFilesToArchive and extractFilesFromArchive.
OptRecursiveRecurse into directories when adding files
OptVerbosePrint information to stderr
OptDestination FilePathDirectory in which to extract
OptLocation FilePath !BoolWhere to place file when adding files and whether to append current path
OptPreserveSymbolicLinksPreserve symbolic links as such. This option is ignored on Windows. WARNING: symbolic link targets are not validated on extraction, so they may be absolute or point outside of the destination directory; do not use this option when extracting untrusted archives.
CRC32Mismatch FilePathUnsafePath FilePathCannotWriteEncryptedEntry FilePathZip64NotSupported StringData too large for the original zip format (which this library is limited to); the ZIP64 extension would be required
Eq ZipExceptionDefined in zip-archive-0.5 · Codec.Archive.ZipData ZipExceptionDefined in zip-archive-0.5 · Codec.Archive.ZipShow ZipExceptionDefined in zip-archive-0.5 · Codec.Archive.ZipException ZipExceptionDefined in zip-archive-0.5 · Codec.Archive.ZipA zip archive with no contents.
Reads an Archive structure from a raw zip archive (in a lazy bytestring).
Writes an Archive structure to a raw zip archive (in a lazy bytestring). Throws a pure Zip64NotSupported exception if the archive has 65535 or more entries or is 4GB or larger, since this would require the (unsupported) ZIP64 extension.
Returns a list of files in a zip archive.
Adds an entry to a zip archive, or updates an existing entry.
Deletes an entry from a zip archive.
Returns Just the zip entry with the specified path, or Nothing.
Returns uncompressed contents of zip entry.
Returns decrypted and uncompressed contents of zip entry.
Check if an Entry is encrypted
toEntry :: FilePathFile path for entry
-> IntegerModification time for entry (seconds since unix epoch)
-> ByteStringContents of entry
-> EntryCreate an Entry with specified file path, modification time, and contents. Throws a pure Zip64NotSupported exception if the contents are too large to be represented without the (unsupported) ZIP64 extension.
Check if an Entry represents a symbolic link
Get the eExternalFileAttributes of an Entry as a CMode a.k.a. FileMode
Generates a Entry from a file or directory.
Writes contents of an Entry to a file. Throws a CRC32Mismatch exception if the CRC32 checksum for the entry does not match the uncompressed data.
Write an Entry representing a symbolic link to a file. If the Entry does not represent a symbolic link or the options do not contain OptPreserveSymbolicLinks, this function behaves like writeEntry.
Note that the symbolic link target is written as is; it may be absolute or point outside of the extraction directory. Do not extract untrusted archives with OptPreserveSymbolicLinks.
Add the specified files to an Archive. If OptRecursive is specified, recursively add files contained in directories. if OptPreserveSymbolicLinks is specified, don't recurse into it. If OptVerbose is specified, print messages to stderr.
Extract all files from an Archive, creating directories as needed. If OptVerbose is specified, print messages to stderr. Note that the last-modified time is set correctly only in POSIX, not in Windows. This function fails if encrypted entries are present. See the warning on OptPreserveSymbolicLinks before using it with untrusted archives.