Documentation

The sum type describes all possible actions that can be performed on an archive.

A collection of maps describing how to produce entries in the resulting archive.

A collection of editing actions, that is, actions that modify already existing entries.

The origin of entries that can be streamed into archive.

The type of the file header: local or central directory.

The data descriptor representation.

A temporary data structure to hold Zip64 extra data field information.

MS-DOS date-time: a pair of Word16 (date, time) with the following structure:

DATE bit     0 - 4           5 - 8           9 - 15
     value   day (1 - 31)    month (1 - 12)  years from 1980
TIME bit     0 - 4           5 - 10          11 - 15
     value   seconds*        minute          hour
             *stored in two-second increments

“Version created by” to specify when writing archive data.

Scan the central directory of an archive and return its description ArchiveDescription as well as a collection of its entries.

This operation may fail with:

• isAlreadyInUseError if the file is already open and cannot be reopened;
• isDoesNotExistError if the file does not exist;
• isPermissionError if the user does not have permission to open the file;
• ParsingFailed when specified archive is something this library cannot parse (this includes multi-disk archives, for example).

Please note that entries with invalid (non-portable) file names may be missing in the list of entries. Files that are compressed with unsupported compression methods are skipped as well. Also, if several entries would collide on some operating systems (such as Windows, because of its case-insensitivity), only one of them will be available, because EntrySelector is case-insensitive. These are the consequences of the design decision to make it impossible to create non-portable archives with this library.

Given location of the archive and information about a specific archive entry EntryDescription, return Source of its data. The actual data can be compressed or uncompressed depending on the third argument.

Undertake all actions specified as the fourth argument of the function. This transforms the given pending actions so they can be performed in one pass, and then they are applied in the most efficient way.

Create a new file with the guarantee that in the case of an exception the old file will be intact. The file is only updated/replaced if the second argument finishes without exceptions.

Determine what comment in new archive will look like given its original value and a collection of pending actions.

Transform a map representing existing entries into a collection of actions that re-create those entires.

Transform a collection of PendingActions into ProducingActions and EditingActions—data that describes how to create resulting archive.

Copy entries from another archive and write them into the file associated with the given handle. This can throw EntryDoesNotExist if there is no such entry in that archive.

Sink an entry from the given stream into the file associated with the given Handle.

Create a Sink to stream data there. Once streaming is finished, return DataDescriptor for the streamed data. The action does not close the given Handle.

Append central directory entries and the end of central directory record to the file that given Handle is associated with. Note that this automatically writes Zip64 end of central directory record and Zip64 end of central directory locator when necessary.

Extract the number of bytes between the start of file name in local header and the start of actual data.

Parse central directory file headers and put them into a Map.

Parse a single central directory file header. If it's a directory or file compressed with unsupported compression method, Nothing is returned.

Parse an extra-field.

Get signature. If the extracted data is not equal to the provided signature, fail.

Parse Zip64ExtraField from its binary representation.

Produce binary representation of Zip64ExtraField.

Create ByteString representing an extra field.

Create ByteString representing the entire central directory.

Create ByteString representing either a local file header or a central directory file header.

Create ByteString representing Zip64 end of central directory record.

Create ByteString representing Zip64 end of the central directory locator.

Parse end of the central directory record or Zip64 end of the central directory record depending on signature binary data begins with.

Create a ByteString representing the end of central directory record.

Find the absolute offset of the end of central directory record or, if present, Zip64 end of central directory record.

Rename an entry (key) in a Map.

Like fromIntegral, but with saturation when converting to bounded types.

Determine the target entry of an action.

Decode a ByteString. The first argument indicates whether we should treat it as UTF-8 (in case bit 11 of general-purpose bit flag is set), otherwise the function assumes CP437. Note that since not every stream of bytes constitutes valid UTF-8 text, this function can fail. In that case Nothing is returned.

Detect if the given text needs newer Unicode-aware features to be properly encoded in the archive.

Convert numeric representation (as per the .ZIP specification) of version into Version.

Covert Version to its numeric representation as per the .ZIP specification.

Get the compression method form its numeric representation.

Convert CompressionMethod to its numeric representation as per the .ZIP specification.

Check if an entry with these parameters needs the Zip64 extension.

Determine “version needed to extract” that should be written to the headers given the need of the Zip64 feature and the compression method.

Return a decompressing Conduit corresponding to the given compression method.

A sink that calculates the CRC32 check sum for an incoming stream.

Convert UTCTime to the MS-DOS time format.

Convert MS-DOS date-time to UTCTime.

The default permissions for the files, permissions not set on Windows, and are set to rw on Unix. This mimics the behavior of the zip utility.