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


-- | Lua module to work with file zips.
--   
--   Module with function for creating, modifying, and extracting files
--   from zip archives.
@package hslua-module-zip
@version 1.1.0


-- | Lua module to work with file zips.
module HsLua.Module.Zip

-- | The <tt>zip</tt> module specification.
documentedModule :: forall e. LuaError e => Module e

-- | The Lua <a>Archive</a> type
typeArchive :: forall e. LuaError e => DocumentedType e Archive

-- | Wrapper for <a>toArchive</a>; converts a string into an Archive.
mkArchive :: forall e. LuaError e => DocumentedFunction e

-- | Creates a new <tt>ZipEntry</tt> from a file; wraps <a>readEntry</a>.
read_entry :: LuaError e => DocumentedFunction e

-- | Creates a new <a>Archive</a> from a list of files.
zip :: LuaError e => DocumentedFunction e

-- | Returns the raw binary string representation of the archive; wraps
--   <a>extractFilesFromArchive</a>
extract :: LuaError e => DocumentedFunction e

-- | Returns the raw binary string representation of the archive.
bytestring :: LuaError e => DocumentedFunction e

-- | The Lua type for <a>Entry</a> objects.
typeEntry :: forall e. LuaError e => DocumentedType e Entry
peekEntryFuzzy :: LuaError e => Peeker e Entry

-- | Returns the uncompressed contents of a zip entry.
contents :: LuaError e => DocumentedFunction e
peekZipOptions :: LuaError e => Peeker e [ZipOption]