HsLua.Module.Zip

hslua-module-zip-1.1.3: Lua module to work with file zips.

Copyright | © 2022-2024 Albert Krewinkel
License | MIT
Maintainer | Albert Krewinkel <tarleb@hslua.org>
Safe Haskell | None
Language | Haskell2010

HsLua.Module.Zip

Contents

- Module
- Zip archives
  - archive methods
- Zip entry
  - entry methods
- Zip Options

Description

Lua module to work with file zips.

Synopsis

- documentedModule :: LuaError e => Module e
- typeArchive :: LuaError e => DocumentedType e Archive
- mkArchive :: LuaError e => DocumentedFunction e
- read_entry :: LuaError e => DocumentedFunction e
- zip :: LuaError e => DocumentedFunction e
- extract :: LuaError e => DocumentedFunction e
- bytestring :: LuaError e => DocumentedFunction e
- typeEntry :: LuaError e => DocumentedType e Entry
- peekEntryFuzzy :: LuaError e => Peeker e Entry
- contents :: LuaError e => DocumentedFunction e
- symlink :: LuaError e => DocumentedFunction e
- peekZipOptions :: LuaError e => Peeker e [ZipOption]

# Module

documentedModule :: LuaError e => Module e #

The `zip` module specification.

# Zip archives

typeArchive :: LuaError e => DocumentedType e Archive #

The Lua `Archive` type

mkArchive :: LuaError e => DocumentedFunction e #

Wrapper for `toArchive`; converts a string into an Archive.

read_entry :: LuaError e => DocumentedFunction e #

Creates a new `ZipEntry` from a file; wraps `readEntry`.

zip :: LuaError e => DocumentedFunction e #

Creates a new `Archive` from a list of files.

## archive methods

extract :: LuaError e => DocumentedFunction e #

Returns the raw binary string representation of the archive; wraps `extractFilesFromArchive`

bytestring :: LuaError e => DocumentedFunction e #

Returns the raw binary string representation of the archive.

# Zip entry

typeEntry :: LuaError e => DocumentedType e Entry #

The Lua type for `Entry` objects.

peekEntryFuzzy :: LuaError e => Peeker e Entry #

## entry methods

contents :: LuaError e => DocumentedFunction e #

Returns the uncompressed contents of a zip entry.

symlink :: LuaError e => DocumentedFunction e #

Returns the target if the Entry represents a symbolic link.

# Zip Options

peekZipOptions :: LuaError e => Peeker e [ZipOption] #