-- 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. The zip archive format is
--   documented in
--   http://www.pkware.com/documents/casestudies/APPNOTE.TXT.
--   
--   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.
--   
--   Archives are built and extracted in memory, so manipulating large zip
--   files will consume a lot of memory. If you work with large zip files
--   or need features not supported by this library, a better choice may be
--   zip, which uses a memory-efficient streaming approach. However,
--   zip can only read and write archives inside instances of MonadIO, so
--   zip-archive is a better choice if you want to manipulate zip archives
--   in "pure" contexts.
--   
--   As an example of the use of the library, a standalone zip archiver and
--   extracter is provided in the source distribution.
@package zip-archive
@version 0.4.3

-- | 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.
--   
--   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
--   http://www.pkware.com/documents/casestudies/APPNOTE.TXT
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 -> !EncryptionMethod -> !Integer -> !Word32 -> !Word32 -> !Word32 -> !ByteString -> !ByteString -> !Word16 -> !Word16 -> !Word32 -> !ByteString -> Entry

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

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

-- | Encryption method
[eEncryptionMethod] :: Entry -> !EncryptionMethod

-- | 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
data EncryptionMethod

-- | Entry is not encrypted
NoEncryption :: EncryptionMethod

-- | Entry is encrypted with the traditional PKWARE encryption
PKWAREEncryption :: !Word8 -> EncryptionMethod

-- | Options for addFilesToArchive and
--   extractFilesFromArchive.
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

-- | Preserve symbolic links as such. This option is ignored on Windows.
OptPreserveSymbolicLinks :: ZipOption
data ZipException
CRC32Mismatch :: FilePath -> ZipException
UnsafePath :: FilePath -> ZipException
CannotWriteEncryptedEntry :: FilePath -> ZipException

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

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

-- | Like toArchive, but returns an Either 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 >=
--   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 Archive 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

-- | Returns decrypted and uncompressed contents of zip entry.
fromEncryptedEntry :: String -> Entry -> Maybe ByteString

-- | Check if an Entry is encrypted
isEncryptedEntry :: Entry -> Bool

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

-- | Check if an Entry represents a symbolic link
isEntrySymbolicLink :: Entry -> Bool

-- | Get the target of a Entry representing a symbolic link. This
--   might fail if the Entry does not represent a symbolic link
symbolicLinkEntryTarget :: Entry -> Maybe FilePath

-- | Get the eExternalFileAttributes of an Entry as a
--   CMode a.k.a. FileMode
entryCMode :: Entry -> CMode

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

-- | 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.
writeEntry :: [ZipOption] -> Entry -> IO ()

-- | 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.
writeSymbolicLinkEntry :: [ZipOption] -> Entry -> IO ()

-- | 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.
addFilesToArchive :: [ZipOption] -> Archive -> [FilePath] -> IO Archive

-- | 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
extractFilesFromArchive :: [ZipOption] -> Archive -> IO ()
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 GHC.Classes.Eq Codec.Archive.Zip.EncryptionMethod
instance GHC.Show.Show Codec.Archive.Zip.EncryptionMethod
instance GHC.Read.Read Codec.Archive.Zip.EncryptionMethod
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.Show.Show Codec.Archive.Zip.Archive
instance GHC.Read.Read Codec.Archive.Zip.Archive
instance GHC.Classes.Eq Codec.Archive.Zip.PKWAREVerificationType
instance GHC.Show.Show Codec.Archive.Zip.PKWAREVerificationType
instance GHC.Read.Read Codec.Archive.Zip.PKWAREVerificationType
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.Classes.Eq Codec.Archive.Zip.ZipException
instance Data.Data.Data Codec.Archive.Zip.ZipException
instance GHC.Show.Show Codec.Archive.Zip.ZipException
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 GHC.Exception.Type.Exception Codec.Archive.Zip.ZipException
instance Data.Binary.Class.Binary Codec.Archive.Zip.Archive
