Sophie: ghc-zip-archive-doc-0.1.1.6-4.fc13 i686

ghc-zip-archive-doc-0.1.1.6-4.fc13.i686.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--Rendered using the Haskell Html Library v0.2-->
<HTML
><HEAD
><META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8"
><TITLE
>Codec.Archive.Zip</TITLE
><LINK HREF="haddock.css" REL="stylesheet" TYPE="text/css"
><SCRIPT SRC="haddock-util.js" TYPE="text/javascript"
></SCRIPT
><SCRIPT TYPE="text/javascript"
>window.onload = function () {setSynopsis("mini_Codec-Archive-Zip.html")};</SCRIPT
></HEAD
><BODY
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="topbar"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD
><IMG SRC="haskell_icon.gif" WIDTH="16" HEIGHT="16" ALT=" "
></TD
><TD CLASS="title"
>zip-archive-0.1.1.6: Library for creating and modifying zip archives.</TD
><TD CLASS="topbut"
><A HREF="src/Codec-Archive-Zip.html"
>Source code</A
></TD
><TD CLASS="topbut"
><A HREF="index.html"
>Contents</A
></TD
><TD CLASS="topbut"
><A HREF="doc-index.html"
>Index</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="modulebar"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD
><FONT SIZE="6"
>Codec.Archive.Zip</FONT
></TD
><TD ALIGN="right"
><TABLE CLASS="narrow" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="infohead"
>Portability</TD
><TD CLASS="infoval"
>so far only tested on GHC</TD
></TR
><TR
><TD CLASS="infohead"
>Stability</TD
><TD CLASS="infoval"
>unstable</TD
></TR
><TR
><TD CLASS="infohead"
>Maintainer</TD
><TD CLASS="infoval"
>John MacFarlane &lt; jgm at berkeley dot edu &gt;</TD
></TR
></TABLE
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="section4"
><B
>Contents</B
></TD
></TR
><TR
><TD
><DL
><DT
><A HREF="#1"
>Data structures
</A
></DT
><DT
><A HREF="#2"
>Pure functions for working with zip archives
</A
></DT
><DT
><A HREF="#3"
>IO functions for working with zip archives
</A
></DT
></DL
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
>Description</TD
></TR
><TR
><TD CLASS="doc"
><P
>The zip-archive library provides functions for creating, modifying,
 and extracting files from zip archives.
</P
><P
>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.
</P
><P
>As an example of the use of the library, a standalone zip archiver
 and extracter, Zip.hs, is provided in the source distribution.
</P
><P
>For more information on the format of zip archives, consult
 <A HREF="http://www.pkware.com/documents/casestudies/APPNOTE.TXT"
>http://www.pkware.com/documents/casestudies/APPNOTE.TXT</A
>
</P
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
>Synopsis</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>data</SPAN
>  <A HREF="#t%3AArchive"
>Archive</A
>  = <A HREF="#v%3AArchive"
>Archive</A
> {<TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="recfield"
><A HREF="#v%3AzEntries"
>zEntries</A
> :: [<A HREF="Codec-Archive-Zip.html#t%3AEntry"
>Entry</A
>]</TD
></TR
><TR
><TD CLASS="recfield"
><A HREF="#v%3AzSignature"
>zSignature</A
> :: Maybe ByteString</TD
></TR
><TR
><TD CLASS="recfield"
><A HREF="#v%3AzComment"
>zComment</A
> :: ByteString</TD
></TR
></TABLE
>}</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>data</SPAN
>  <A HREF="#t%3AEntry"
>Entry</A
>  = <A HREF="#v%3AEntry"
>Entry</A
> {<TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="recfield"
><A HREF="#v%3AeRelativePath"
>eRelativePath</A
> :: FilePath</TD
></TR
><TR
><TD CLASS="recfield"
><A HREF="#v%3AeCompressionMethod"
>eCompressionMethod</A
> :: <A HREF="Codec-Archive-Zip.html#t%3ACompressionMethod"
>CompressionMethod</A
></TD
></TR
><TR
><TD CLASS="recfield"
><A HREF="#v%3AeLastModified"
>eLastModified</A
> :: Integer</TD
></TR
><TR
><TD CLASS="recfield"
><A HREF="#v%3AeCRC32"
>eCRC32</A
> :: Word32</TD
></TR
><TR
><TD CLASS="recfield"
><A HREF="#v%3AeCompressedSize"
>eCompressedSize</A
> :: Word32</TD
></TR
><TR
><TD CLASS="recfield"
><A HREF="#v%3AeUncompressedSize"
>eUncompressedSize</A
> :: Word32</TD
></TR
><TR
><TD CLASS="recfield"
><A HREF="#v%3AeExtraField"
>eExtraField</A
> :: ByteString</TD
></TR
><TR
><TD CLASS="recfield"
><A HREF="#v%3AeFileComment"
>eFileComment</A
> :: ByteString</TD
></TR
><TR
><TD CLASS="recfield"
><A HREF="#v%3AeInternalFileAttributes"
>eInternalFileAttributes</A
> :: Word16</TD
></TR
><TR
><TD CLASS="recfield"
><A HREF="#v%3AeExternalFileAttributes"
>eExternalFileAttributes</A
> :: Word32</TD
></TR
><TR
><TD CLASS="recfield"
><A HREF="#v%3AeCompressedData"
>eCompressedData</A
> :: ByteString</TD
></TR
></TABLE
>}</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>data</SPAN
>  <A HREF="#t%3ACompressionMethod"
>CompressionMethod</A
>  </TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="decl"
>= <A HREF="#v%3ADeflate"
>Deflate</A
></TD
></TR
><TR
><TD CLASS="decl"
>| <A HREF="#v%3ANoCompression"
>NoCompression</A
></TD
></TR
></TABLE
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>data</SPAN
>  <A HREF="#t%3AZipOption"
>ZipOption</A
>  </TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="decl"
>= <A HREF="#v%3AOptRecursive"
>OptRecursive</A
></TD
></TR
><TR
><TD CLASS="decl"
>| <A HREF="#v%3AOptVerbose"
>OptVerbose</A
></TD
></TR
></TABLE
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AemptyArchive"
>emptyArchive</A
> :: <A HREF="Codec-Archive-Zip.html#t%3AArchive"
>Archive</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AtoArchive"
>toArchive</A
> :: ByteString -&gt; <A HREF="Codec-Archive-Zip.html#t%3AArchive"
>Archive</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AfromArchive"
>fromArchive</A
> :: <A HREF="Codec-Archive-Zip.html#t%3AArchive"
>Archive</A
> -&gt; ByteString</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AfilesInArchive"
>filesInArchive</A
> :: <A HREF="Codec-Archive-Zip.html#t%3AArchive"
>Archive</A
> -&gt; [FilePath]</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AaddEntryToArchive"
>addEntryToArchive</A
> :: <A HREF="Codec-Archive-Zip.html#t%3AEntry"
>Entry</A
> -&gt; <A HREF="Codec-Archive-Zip.html#t%3AArchive"
>Archive</A
> -&gt; <A HREF="Codec-Archive-Zip.html#t%3AArchive"
>Archive</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AdeleteEntryFromArchive"
>deleteEntryFromArchive</A
> :: FilePath -&gt; <A HREF="Codec-Archive-Zip.html#t%3AArchive"
>Archive</A
> -&gt; <A HREF="Codec-Archive-Zip.html#t%3AArchive"
>Archive</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AfindEntryByPath"
>findEntryByPath</A
> :: FilePath -&gt; <A HREF="Codec-Archive-Zip.html#t%3AArchive"
>Archive</A
> -&gt; Maybe <A HREF="Codec-Archive-Zip.html#t%3AEntry"
>Entry</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AfromEntry"
>fromEntry</A
> :: <A HREF="Codec-Archive-Zip.html#t%3AEntry"
>Entry</A
> -&gt; ByteString</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AtoEntry"
>toEntry</A
> :: FilePath -&gt; Integer -&gt; ByteString -&gt; <A HREF="Codec-Archive-Zip.html#t%3AEntry"
>Entry</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AreadEntry"
>readEntry</A
> :: [<A HREF="Codec-Archive-Zip.html#t%3AZipOption"
>ZipOption</A
>] -&gt; FilePath -&gt; IO <A HREF="Codec-Archive-Zip.html#t%3AEntry"
>Entry</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AwriteEntry"
>writeEntry</A
> :: [<A HREF="Codec-Archive-Zip.html#t%3AZipOption"
>ZipOption</A
>] -&gt; <A HREF="Codec-Archive-Zip.html#t%3AEntry"
>Entry</A
> -&gt; IO ()</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AaddFilesToArchive"
>addFilesToArchive</A
> :: [<A HREF="Codec-Archive-Zip.html#t%3AZipOption"
>ZipOption</A
>] -&gt; <A HREF="Codec-Archive-Zip.html#t%3AArchive"
>Archive</A
> -&gt; [FilePath] -&gt; IO <A HREF="Codec-Archive-Zip.html#t%3AArchive"
>Archive</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AextractFilesFromArchive"
>extractFilesFromArchive</A
> :: [<A HREF="Codec-Archive-Zip.html#t%3AZipOption"
>ZipOption</A
>] -&gt; <A HREF="Codec-Archive-Zip.html#t%3AArchive"
>Archive</A
> -&gt; IO ()</TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
><A NAME="1"
><A NAME="1"
>Data structures
</A
></A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><SPAN CLASS="keyword"
>data</SPAN
>  <A NAME="t:Archive"
><A NAME="t%3AArchive"
></A
></A
><B
>Archive</B
>  </TD
><TD CLASS="declbut"
><A HREF="src/Codec-Archive-Zip.html#Archive"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="ndoc"
>Structured representation of a zip archive, including directory
 information and contents (in lazy bytestrings).
</TD
></TR
><TR
><TD CLASS="section4"
>Constructors</TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="5" CELLPADDING="0"
><TR
><TD CLASS="arg"
><A NAME="v:Archive"
><A NAME="v%3AArchive"
></A
></A
><B
>Archive</B
></TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="body" COLSPAN="2"
><TABLE CLASS="vanilla" CELLSPACING="1" CELLPADDING="0"
><TR
><TD CLASS="arg"
><A NAME="v:zEntries"
><A NAME="v%3AzEntries"
></A
></A
><B
>zEntries</B
> :: [<A HREF="Codec-Archive-Zip.html#t%3AEntry"
>Entry</A
>]</TD
><TD CLASS="rdoc"
>Files in zip archive
</TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:zSignature"
><A NAME="v%3AzSignature"
></A
></A
><B
>zSignature</B
> :: Maybe ByteString</TD
><TD CLASS="rdoc"
>Digital signature
</TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:zComment"
><A NAME="v%3AzComment"
></A
></A
><B
>zComment</B
> :: ByteString</TD
><TD CLASS="rdoc"
>Comment for whole zip archive
</TD
></TR
></TABLE
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="section4"
><IMG SRC="minus.gif" CLASS="coll" ONCLICK="toggle(this,'i:Archive')" ALT="show/hide"
> Instances</TD
></TR
><TR
><TD CLASS="body"
><DIV ID="i:Archive" STYLE="display:block;"
><TABLE CLASS="vanilla" CELLSPACING="1" CELLPADDING="0"
><TR
><TD CLASS="decl"
>Read <A HREF="Codec-Archive-Zip.html#t%3AArchive"
>Archive</A
></TD
></TR
><TR
><TD CLASS="decl"
>Show <A HREF="Codec-Archive-Zip.html#t%3AArchive"
>Archive</A
></TD
></TR
></TABLE
></DIV
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><SPAN CLASS="keyword"
>data</SPAN
>  <A NAME="t:Entry"
><A NAME="t%3AEntry"
></A
></A
><B
>Entry</B
>  </TD
><TD CLASS="declbut"
><A HREF="src/Codec-Archive-Zip.html#Entry"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="ndoc"
>Representation of an archived file, including content and metadata.
</TD
></TR
><TR
><TD CLASS="section4"
>Constructors</TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="5" CELLPADDING="0"
><TR
><TD CLASS="arg"
><A NAME="v:Entry"
><A NAME="v%3AEntry"
></A
></A
><B
>Entry</B
></TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="body" COLSPAN="2"
><TABLE CLASS="vanilla" CELLSPACING="1" CELLPADDING="0"
><TR
><TD CLASS="arg"
><A NAME="v:eRelativePath"
><A NAME="v%3AeRelativePath"
></A
></A
><B
>eRelativePath</B
> :: FilePath</TD
><TD CLASS="rdoc"
>Relative path, using <TT
>/</TT
> as separator
</TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:eCompressionMethod"
><A NAME="v%3AeCompressionMethod"
></A
></A
><B
>eCompressionMethod</B
> :: <A HREF="Codec-Archive-Zip.html#t%3ACompressionMethod"
>CompressionMethod</A
></TD
><TD CLASS="rdoc"
>Compression method
</TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:eLastModified"
><A NAME="v%3AeLastModified"
></A
></A
><B
>eLastModified</B
> :: Integer</TD
><TD CLASS="rdoc"
>Modification time (seconds since unix epoch)
</TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:eCRC32"
><A NAME="v%3AeCRC32"
></A
></A
><B
>eCRC32</B
> :: Word32</TD
><TD CLASS="rdoc"
>CRC32 checksum
</TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:eCompressedSize"
><A NAME="v%3AeCompressedSize"
></A
></A
><B
>eCompressedSize</B
> :: Word32</TD
><TD CLASS="rdoc"
>Compressed size in bytes
</TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:eUncompressedSize"
><A NAME="v%3AeUncompressedSize"
></A
></A
><B
>eUncompressedSize</B
> :: Word32</TD
><TD CLASS="rdoc"
>Uncompressed size in bytes
</TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:eExtraField"
><A NAME="v%3AeExtraField"
></A
></A
><B
>eExtraField</B
> :: ByteString</TD
><TD CLASS="rdoc"
>Extra field - unused by this library
</TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:eFileComment"
><A NAME="v%3AeFileComment"
></A
></A
><B
>eFileComment</B
> :: ByteString</TD
><TD CLASS="rdoc"
>File comment - unused by this library
</TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:eInternalFileAttributes"
><A NAME="v%3AeInternalFileAttributes"
></A
></A
><B
>eInternalFileAttributes</B
> :: Word16</TD
><TD CLASS="rdoc"
>Internal file attributes - unused by this library
</TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:eExternalFileAttributes"
><A NAME="v%3AeExternalFileAttributes"
></A
></A
><B
>eExternalFileAttributes</B
> :: Word32</TD
><TD CLASS="rdoc"
>External file attributes (system-dependent)
</TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:eCompressedData"
><A NAME="v%3AeCompressedData"
></A
></A
><B
>eCompressedData</B
> :: ByteString</TD
><TD CLASS="rdoc"
>Compressed contents of file
</TD
></TR
></TABLE
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="section4"
><IMG SRC="minus.gif" CLASS="coll" ONCLICK="toggle(this,'i:Entry')" ALT="show/hide"
> Instances</TD
></TR
><TR
><TD CLASS="body"
><DIV ID="i:Entry" STYLE="display:block;"
><TABLE CLASS="vanilla" CELLSPACING="1" CELLPADDING="0"
><TR
><TD CLASS="decl"
>Eq <A HREF="Codec-Archive-Zip.html#t%3AEntry"
>Entry</A
></TD
></TR
><TR
><TD CLASS="decl"
>Read <A HREF="Codec-Archive-Zip.html#t%3AEntry"
>Entry</A
></TD
></TR
><TR
><TD CLASS="decl"
>Show <A HREF="Codec-Archive-Zip.html#t%3AEntry"
>Entry</A
></TD
></TR
></TABLE
></DIV
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><SPAN CLASS="keyword"
>data</SPAN
>  <A NAME="t:CompressionMethod"
><A NAME="t%3ACompressionMethod"
></A
></A
><B
>CompressionMethod</B
>  </TD
><TD CLASS="declbut"
><A HREF="src/Codec-Archive-Zip.html#CompressionMethod"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="ndoc"
>Compression methods.
</TD
></TR
><TR
><TD CLASS="section4"
>Constructors</TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="1" CELLPADDING="0"
><TR
><TD CLASS="arg"
><A NAME="v:Deflate"
><A NAME="v%3ADeflate"
></A
></A
><B
>Deflate</B
></TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:NoCompression"
><A NAME="v%3ANoCompression"
></A
></A
><B
>NoCompression</B
></TD
><TD CLASS="rdoc"
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="section4"
><IMG SRC="minus.gif" CLASS="coll" ONCLICK="toggle(this,'i:CompressionMethod')" ALT="show/hide"
> Instances</TD
></TR
><TR
><TD CLASS="body"
><DIV ID="i:CompressionMethod" STYLE="display:block;"
><TABLE CLASS="vanilla" CELLSPACING="1" CELLPADDING="0"
><TR
><TD CLASS="decl"
>Eq <A HREF="Codec-Archive-Zip.html#t%3ACompressionMethod"
>CompressionMethod</A
></TD
></TR
><TR
><TD CLASS="decl"
>Read <A HREF="Codec-Archive-Zip.html#t%3ACompressionMethod"
>CompressionMethod</A
></TD
></TR
><TR
><TD CLASS="decl"
>Show <A HREF="Codec-Archive-Zip.html#t%3ACompressionMethod"
>CompressionMethod</A
></TD
></TR
></TABLE
></DIV
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><SPAN CLASS="keyword"
>data</SPAN
>  <A NAME="t:ZipOption"
><A NAME="t%3AZipOption"
></A
></A
><B
>ZipOption</B
>  </TD
><TD CLASS="declbut"
><A HREF="src/Codec-Archive-Zip.html#ZipOption"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="ndoc"
>Options for <TT
><A HREF="Codec-Archive-Zip.html#v%3AaddFilesToArchive"
>addFilesToArchive</A
></TT
> and <TT
><A HREF="Codec-Archive-Zip.html#v%3AextractFilesFromArchive"
>extractFilesFromArchive</A
></TT
>.
</TD
></TR
><TR
><TD CLASS="section4"
>Constructors</TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="1" CELLPADDING="0"
><TR
><TD CLASS="arg"
><A NAME="v:OptRecursive"
><A NAME="v%3AOptRecursive"
></A
></A
><B
>OptRecursive</B
></TD
><TD CLASS="rdoc"
>Recurse into directories when adding files
</TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:OptVerbose"
><A NAME="v%3AOptVerbose"
></A
></A
><B
>OptVerbose</B
></TD
><TD CLASS="rdoc"
>Print information to stderr
</TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="section4"
><IMG SRC="minus.gif" CLASS="coll" ONCLICK="toggle(this,'i:ZipOption')" ALT="show/hide"
> Instances</TD
></TR
><TR
><TD CLASS="body"
><DIV ID="i:ZipOption" STYLE="display:block;"
><TABLE CLASS="vanilla" CELLSPACING="1" CELLPADDING="0"
><TR
><TD CLASS="decl"
>Eq <A HREF="Codec-Archive-Zip.html#t%3AZipOption"
>ZipOption</A
></TD
></TR
><TR
><TD CLASS="decl"
>Read <A HREF="Codec-Archive-Zip.html#t%3AZipOption"
>ZipOption</A
></TD
></TR
><TR
><TD CLASS="decl"
>Show <A HREF="Codec-Archive-Zip.html#t%3AZipOption"
>ZipOption</A
></TD
></TR
></TABLE
></DIV
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:emptyArchive"
><A NAME="v%3AemptyArchive"
></A
></A
><B
>emptyArchive</B
> :: <A HREF="Codec-Archive-Zip.html#t%3AArchive"
>Archive</A
></TD
><TD CLASS="declbut"
><A HREF="src/Codec-Archive-Zip.html#emptyArchive"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>A zip archive with no contents.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
><A NAME="2"
><A NAME="2"
>Pure functions for working with zip archives
</A
></A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:toArchive"
><A NAME="v%3AtoArchive"
></A
></A
><B
>toArchive</B
> :: ByteString -&gt; <A HREF="Codec-Archive-Zip.html#t%3AArchive"
>Archive</A
></TD
><TD CLASS="declbut"
><A HREF="src/Codec-Archive-Zip.html#toArchive"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>Reads an <TT
><A HREF="Codec-Archive-Zip.html#t%3AArchive"
>Archive</A
></TT
> structure from a raw zip archive (in a lazy bytestring).
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:fromArchive"
><A NAME="v%3AfromArchive"
></A
></A
><B
>fromArchive</B
> :: <A HREF="Codec-Archive-Zip.html#t%3AArchive"
>Archive</A
> -&gt; ByteString</TD
><TD CLASS="declbut"
><A HREF="src/Codec-Archive-Zip.html#fromArchive"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>Writes an <TT
><A HREF="Codec-Archive-Zip.html#t%3AArchive"
>Archive</A
></TT
> structure to a raw zip archive (in a lazy bytestring).
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:filesInArchive"
><A NAME="v%3AfilesInArchive"
></A
></A
><B
>filesInArchive</B
> :: <A HREF="Codec-Archive-Zip.html#t%3AArchive"
>Archive</A
> -&gt; [FilePath]</TD
><TD CLASS="declbut"
><A HREF="src/Codec-Archive-Zip.html#filesInArchive"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>Returns a list of files in a zip archive.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:addEntryToArchive"
><A NAME="v%3AaddEntryToArchive"
></A
></A
><B
>addEntryToArchive</B
> :: <A HREF="Codec-Archive-Zip.html#t%3AEntry"
>Entry</A
> -&gt; <A HREF="Codec-Archive-Zip.html#t%3AArchive"
>Archive</A
> -&gt; <A HREF="Codec-Archive-Zip.html#t%3AArchive"
>Archive</A
></TD
><TD CLASS="declbut"
><A HREF="src/Codec-Archive-Zip.html#addEntryToArchive"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>Adds an entry to a zip archive, or updates an existing entry.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:deleteEntryFromArchive"
><A NAME="v%3AdeleteEntryFromArchive"
></A
></A
><B
>deleteEntryFromArchive</B
> :: FilePath -&gt; <A HREF="Codec-Archive-Zip.html#t%3AArchive"
>Archive</A
> -&gt; <A HREF="Codec-Archive-Zip.html#t%3AArchive"
>Archive</A
></TD
><TD CLASS="declbut"
><A HREF="src/Codec-Archive-Zip.html#deleteEntryFromArchive"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>Deletes an entry from a zip archive.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:findEntryByPath"
><A NAME="v%3AfindEntryByPath"
></A
></A
><B
>findEntryByPath</B
> :: FilePath -&gt; <A HREF="Codec-Archive-Zip.html#t%3AArchive"
>Archive</A
> -&gt; Maybe <A HREF="Codec-Archive-Zip.html#t%3AEntry"
>Entry</A
></TD
><TD CLASS="declbut"
><A HREF="src/Codec-Archive-Zip.html#findEntryByPath"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>Returns Just the zip entry with the specified path, or Nothing.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:fromEntry"
><A NAME="v%3AfromEntry"
></A
></A
><B
>fromEntry</B
> :: <A HREF="Codec-Archive-Zip.html#t%3AEntry"
>Entry</A
> -&gt; ByteString</TD
><TD CLASS="declbut"
><A HREF="src/Codec-Archive-Zip.html#fromEntry"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>Returns uncompressed contents of zip entry.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:toEntry"
><A NAME="v%3AtoEntry"
></A
></A
><B
>toEntry</B
></TD
><TD CLASS="declbut"
><A HREF="src/Codec-Archive-Zip.html#toEntry"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="arg"
>:: FilePath</TD
><TD CLASS="rdoc"
>File path for entry
</TD
></TR
><TR
><TD CLASS="arg"
>-&gt; Integer</TD
><TD CLASS="rdoc"
>Modification time for entry (seconds since unix epoch)
</TD
></TR
><TR
><TD CLASS="arg"
>-&gt; ByteString</TD
><TD CLASS="rdoc"
>Contents of entry
</TD
></TR
><TR
><TD CLASS="arg"
>-&gt; <A HREF="Codec-Archive-Zip.html#t%3AEntry"
>Entry</A
></TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="ndoc" COLSPAN="2"
>Create an <TT
><A HREF="Codec-Archive-Zip.html#t%3AEntry"
>Entry</A
></TT
> with specified file path, modification time, and contents.
</TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
><A NAME="3"
><A NAME="3"
>IO functions for working with zip archives
</A
></A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:readEntry"
><A NAME="v%3AreadEntry"
></A
></A
><B
>readEntry</B
> :: [<A HREF="Codec-Archive-Zip.html#t%3AZipOption"
>ZipOption</A
>] -&gt; FilePath -&gt; IO <A HREF="Codec-Archive-Zip.html#t%3AEntry"
>Entry</A
></TD
><TD CLASS="declbut"
><A HREF="src/Codec-Archive-Zip.html#readEntry"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>Generates a <TT
><A HREF="Codec-Archive-Zip.html#t%3AEntry"
>Entry</A
></TT
> from a file or directory.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:writeEntry"
><A NAME="v%3AwriteEntry"
></A
></A
><B
>writeEntry</B
> :: [<A HREF="Codec-Archive-Zip.html#t%3AZipOption"
>ZipOption</A
>] -&gt; <A HREF="Codec-Archive-Zip.html#t%3AEntry"
>Entry</A
> -&gt; IO ()</TD
><TD CLASS="declbut"
><A HREF="src/Codec-Archive-Zip.html#writeEntry"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>Writes contents of an <TT
><A HREF="Codec-Archive-Zip.html#t%3AEntry"
>Entry</A
></TT
> to a file.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:addFilesToArchive"
><A NAME="v%3AaddFilesToArchive"
></A
></A
><B
>addFilesToArchive</B
> :: [<A HREF="Codec-Archive-Zip.html#t%3AZipOption"
>ZipOption</A
>] -&gt; <A HREF="Codec-Archive-Zip.html#t%3AArchive"
>Archive</A
> -&gt; [FilePath] -&gt; IO <A HREF="Codec-Archive-Zip.html#t%3AArchive"
>Archive</A
></TD
><TD CLASS="declbut"
><A HREF="src/Codec-Archive-Zip.html#addFilesToArchive"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>Add the specified files to an <TT
><A HREF="Codec-Archive-Zip.html#t%3AArchive"
>Archive</A
></TT
>.  If <TT
><A HREF="Codec-Archive-Zip.html#v%3AOptRecursive"
>OptRecursive</A
></TT
> is specified,
 recursively add files contained in directories.  If <TT
><A HREF="Codec-Archive-Zip.html#v%3AOptVerbose"
>OptVerbose</A
></TT
> is specified,
 print messages to stderr.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:extractFilesFromArchive"
><A NAME="v%3AextractFilesFromArchive"
></A
></A
><B
>extractFilesFromArchive</B
> :: [<A HREF="Codec-Archive-Zip.html#t%3AZipOption"
>ZipOption</A
>] -&gt; <A HREF="Codec-Archive-Zip.html#t%3AArchive"
>Archive</A
> -&gt; IO ()</TD
><TD CLASS="declbut"
><A HREF="src/Codec-Archive-Zip.html#extractFilesFromArchive"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>Extract all files from an <TT
><A HREF="Codec-Archive-Zip.html#t%3AArchive"
>Archive</A
></TT
>, creating directories
 as needed.  If <TT
><A HREF="Codec-Archive-Zip.html#v%3AOptVerbose"
>OptVerbose</A
></TT
> is specified, print messages to stderr.
 Note that the last-modified time is set correctly only in POSIX,
 not in Windows.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="botbar"
>Produced by <A HREF="http://www.haskell.org/haddock/"
>Haddock</A
> version 2.6.0</TD
></TR
></TABLE
></BODY
></HTML
>