-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Library for creating and modifying zip archives.
--   
--   The zip-archive library provides functions for creating, modifying,
--   and extracting files from zip archives.
@package zip-archive
@version 0.3.0.2


-- | 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 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.
--   
--   As an example of the use of the library, a standalone zip archiver and
--   extracter, Zip.hs, is provided in the source distribution.
--   
--   For more information on the format of zip archives, consult
--   <a>http://www.pkware.com/documents/casestudies/APPNOTE.TXT</a>
module Codec.Archive.Zip

-- | Structured representation of a zip archive, including directory
--   information and contents (in lazy bytestrings).
data Archive
Archive :: [Entry] -> Maybe ByteString -> ByteString -> Archive

-- | Files in zip archive
[zEntries] :: Archive -> [Entry]

-- | Digital signature
[zSignature] :: Archive -> Maybe ByteString

-- | Comment for whole zip archive
[zComment] :: Archive -> ByteString

-- | Representation of an archived file, including content and metadata.
data Entry
Entry :: FilePath -> CompressionMethod -> Integer -> Word32 -> Word32 -> Word32 -> ByteString -> ByteString -> Word16 -> Word16 -> Word32 -> ByteString -> Entry

-- | Relative path, using <a>/</a> as separator
[eRelativePath] :: Entry -> FilePath

-- | Compression method
[eCompressionMethod] :: Entry -> CompressionMethod

-- | Modification time (seconds since unix epoch)
[eLastModified] :: Entry -> Integer

-- | CRC32 checksum
[eCRC32] :: Entry -> Word32

-- | Compressed size in bytes
[eCompressedSize] :: Entry -> Word32

-- | Uncompressed size in bytes
[eUncompressedSize] :: Entry -> Word32

-- | Extra field - unused by this library
[eExtraField] :: Entry -> ByteString

-- | File comment - unused by this library
[eFileComment] :: Entry -> ByteString

-- | Version made by field
[eVersionMadeBy] :: Entry -> Word16

-- | Internal file attributes - unused by this library
[eInternalFileAttributes] :: Entry -> Word16

-- | External file attributes (system-dependent)
[eExternalFileAttributes] :: Entry -> Word32

-- | Compressed contents of file
[eCompressedData] :: Entry -> ByteString

-- | Compression methods.
data CompressionMethod
Deflate :: CompressionMethod
NoCompression :: CompressionMethod

-- | Options for <a>addFilesToArchive</a> and
--   <a>extractFilesFromArchive</a>.
data ZipOption

-- | Recurse into directories when adding files
OptRecursive :: ZipOption

-- | Print information to stderr
OptVerbose :: ZipOption

-- | Directory in which to extract
OptDestination :: FilePath -> ZipOption

-- | Where to place file when adding files and whether to append current
--   path
OptLocation :: FilePath -> Bool -> ZipOption
data ZipException
CRC32Mismatch :: FilePath -> ZipException

-- | A zip archive with no contents.
emptyArchive :: Archive

-- | Reads an <a>Archive</a> structure from a raw zip archive (in a lazy
--   bytestring).
toArchive :: ByteString -> Archive

-- | Like <a>toArchive</a>, but returns an <a>Either</a> value instead of
--   raising an error if the archive cannot be decoded. NOTE: This function
--   only works properly when the library is compiled against binary &gt;=
--   0.7. With earlier versions, it will always return a Right value,
--   raising an error if parsing fails.
toArchiveOrFail :: ByteString -> Either String Archive

-- | Writes an <a>Archive</a> structure to a raw zip archive (in a lazy
--   bytestring).
fromArchive :: Archive -> ByteString

-- | Returns a list of files in a zip archive.
filesInArchive :: Archive -> [FilePath]

-- | Adds an entry to a zip archive, or updates an existing entry.
addEntryToArchive :: Entry -> Archive -> Archive

-- | Deletes an entry from a zip archive.
deleteEntryFromArchive :: FilePath -> Archive -> Archive

-- | Returns Just the zip entry with the specified path, or Nothing.
findEntryByPath :: FilePath -> Archive -> Maybe Entry

-- | Returns uncompressed contents of zip entry.
fromEntry :: Entry -> ByteString

-- | Create an <a>Entry</a> with specified file path, modification time,
--   and contents.
toEntry :: FilePath -> Integer -> ByteString -> Entry

-- | Generates a <a>Entry</a> from a file or directory.
readEntry :: [ZipOption] -> FilePath -> IO Entry

-- | Writes contents of an <a>Entry</a> to a file. Throws a
--   <a>CRC32Mismatch</a> exception if the CRC32 checksum for the entry
--   does not match the uncompressed data.
writeEntry :: [ZipOption] -> Entry -> IO ()

-- | Add the specified files to an <a>Archive</a>. If <a>OptRecursive</a>
--   is specified, recursively add files contained in directories. If
--   <a>OptVerbose</a> is specified, print messages to stderr.
addFilesToArchive :: [ZipOption] -> Archive -> [FilePath] -> IO Archive

-- | Extract all files from an <a>Archive</a>, creating directories as
--   needed. If <a>OptVerbose</a> is specified, print messages to stderr.
--   Note that the last-modified time is set correctly only in POSIX, not
--   in Windows.
extractFilesFromArchive :: [ZipOption] -> Archive -> IO ()
instance GHC.Classes.Eq Codec.Archive.Zip.MSDOSDateTime
instance GHC.Show.Show Codec.Archive.Zip.MSDOSDateTime
instance GHC.Read.Read Codec.Archive.Zip.MSDOSDateTime
instance Data.Data.Data Codec.Archive.Zip.ZipException
instance GHC.Show.Show Codec.Archive.Zip.ZipException
instance GHC.Classes.Eq Codec.Archive.Zip.ZipOption
instance GHC.Show.Show Codec.Archive.Zip.ZipOption
instance GHC.Read.Read Codec.Archive.Zip.ZipOption
instance GHC.Show.Show Codec.Archive.Zip.Archive
instance GHC.Read.Read Codec.Archive.Zip.Archive
instance GHC.Classes.Eq Codec.Archive.Zip.Entry
instance GHC.Show.Show Codec.Archive.Zip.Entry
instance GHC.Read.Read Codec.Archive.Zip.Entry
instance GHC.Classes.Eq Codec.Archive.Zip.CompressionMethod
instance GHC.Show.Show Codec.Archive.Zip.CompressionMethod
instance GHC.Read.Read Codec.Archive.Zip.CompressionMethod
instance Data.Binary.Class.Binary Codec.Archive.Zip.Archive
instance GHC.Exception.Exception Codec.Archive.Zip.ZipException
