Safe Haskell	Safe
Language	Haskell98

Codec.Archive.LibZip.Types

Synopsis

Documentation

type Zip = Ptr C'zip #

Handler of the open zip file.

type ZipFile = Ptr C'zip_file #

Handler of an open file in the zip archive.

type ZipSource = Ptr C'zip_source #

Handler of data source for new files in the zip archive. Constructors: sourceBuffer, sourceFile, sourceZip, sourcePure.

data ZipStat #

File statistics expressed in native Haskell types.

Constructors

ZipStat
Fields zs'valid :: Word64 zs'name :: String zs'index :: Integer zs'size :: Integer zs'comp_size :: Integer zs'mtime :: UTCTime zs'crc :: Word zs'comp_method :: ZipCompMethod zs'encryption_method :: ZipEncryptionMethod zs'flags :: Word32

Instances

Eq ZipStat #
Methods (==) :: ZipStat -> ZipStat -> Bool # (/=) :: ZipStat -> ZipStat -> Bool #
Show ZipStat #
Methods showsPrec :: Int -> ZipStat -> ShowS # show :: ZipStat -> String # showList :: [ZipStat] -> ShowS #

toZipStat :: C'zip_stat -> IO ZipStat #

Convert marshalled stat record.

data OpenFlag #

Flags for opening an archive.

Constructors

CreateFlag	Create an archive if it does not exist.
ExclFlag	Error if the archive already exists.
CheckConsFlag	Check archive's consistency and error on failure.
TruncateFlag	If archive exists, ignore its current content.

Instances

Enum OpenFlag #
Methods succ :: OpenFlag -> OpenFlag # pred :: OpenFlag -> OpenFlag # toEnum :: Int -> OpenFlag # fromEnum :: OpenFlag -> Int # enumFrom :: OpenFlag -> [OpenFlag] # enumFromThen :: OpenFlag -> OpenFlag -> [OpenFlag] # enumFromTo :: OpenFlag -> OpenFlag -> [OpenFlag] # enumFromThenTo :: OpenFlag -> OpenFlag -> OpenFlag -> [OpenFlag] #
Eq OpenFlag #
Methods (==) :: OpenFlag -> OpenFlag -> Bool # (/=) :: OpenFlag -> OpenFlag -> Bool #
Show OpenFlag #
Methods showsPrec :: Int -> OpenFlag -> ShowS # show :: OpenFlag -> String # showList :: [OpenFlag] -> ShowS #

data FileFlag #

Flags for accessing files in the archive. Please consult libzip documentation about their use.

Constructors

FileNOCASE	Ignore case on name lookup.
FileNODIR	Ignore directory component.
FileCOMPRESSED	Read the compressed data.
FileUNCHANGED	Read the original data, ignore changes.
FileRECOMPRESS	Force recompression of data.
FileENCRYPTED	Read encrypted data (implies FileCOMPRESSED).
FileENC_GUESS	Guess string encoding (default).
FileENC_RAW	Get unmodified string.
FileENC_STRICT	Follow specification strictly.
FileLOCAL	In local header.
FileCENTRAL	In central directory.
FileENC_UTF_8	String is UTF-8 encoded.
FileENC_CP437	String is CP437 encoded.
FileOVERWRITE	When adding files: if file name exists, overwrite.

Instances

Enum FileFlag #
Methods succ :: FileFlag -> FileFlag # pred :: FileFlag -> FileFlag # toEnum :: Int -> FileFlag # fromEnum :: FileFlag -> Int # enumFrom :: FileFlag -> [FileFlag] # enumFromThen :: FileFlag -> FileFlag -> [FileFlag] # enumFromTo :: FileFlag -> FileFlag -> [FileFlag] # enumFromThenTo :: FileFlag -> FileFlag -> FileFlag -> [FileFlag] #
Eq FileFlag #
Methods (==) :: FileFlag -> FileFlag -> Bool # (/=) :: FileFlag -> FileFlag -> Bool #
Show FileFlag #
Methods showsPrec :: Int -> FileFlag -> ShowS # show :: FileFlag -> String # showList :: [FileFlag] -> ShowS #

data ArchiveFlag #

libzip archive global flags

Constructors

ArchiveRDONLY

Instances

Enum ArchiveFlag #
Methods succ :: ArchiveFlag -> ArchiveFlag # pred :: ArchiveFlag -> ArchiveFlag # toEnum :: Int -> ArchiveFlag # fromEnum :: ArchiveFlag -> Int # enumFrom :: ArchiveFlag -> [ArchiveFlag] # enumFromThen :: ArchiveFlag -> ArchiveFlag -> [ArchiveFlag] # enumFromTo :: ArchiveFlag -> ArchiveFlag -> [ArchiveFlag] # enumFromThenTo :: ArchiveFlag -> ArchiveFlag -> ArchiveFlag -> [ArchiveFlag] #
Eq ArchiveFlag #
Methods (==) :: ArchiveFlag -> ArchiveFlag -> Bool # (/=) :: ArchiveFlag -> ArchiveFlag -> Bool #
Show ArchiveFlag #
Methods showsPrec :: Int -> ArchiveFlag -> ShowS # show :: ArchiveFlag -> String # showList :: [ArchiveFlag] -> ShowS #

data ZipError #

libzip error codes.

Constructors

ErrOK	No error.
ErrMULTIDISK	Multi-disk zip archives not supported.
ErrRENAME	Renaming temporary file failed.
ErrCLOSE	Closing zip archive failed.
ErrSEEK	Seek error.
ErrREAD	Read error.
ErrWRITE	Write error.
ErrCRC	CRC error.
ErrZIPCLOSED	Containing zip archive was closed.
ErrNOENT	No such file.
ErrEXISTS	File already exists.
ErrOPEN	Can't open file.
ErrTMPOPEN	Failure to create temporary file.
ErrZLIB	Zlib error.
ErrMEMORY	Malloc error.
ErrCHANGED	Entry has been changed.
ErrCOMPNOTSUPP	Compression method not supported.
ErrEOF	Premature EOF.
ErrINVAL	Invalid argument.
ErrNOZIP	Not a zip archive.
ErrINTERNAL	Internal error.
ErrINCONS	Zip archive inconsistent.
ErrREMOVE	Can't remove file.
ErrDELETED	Entry has been deleted.
ErrENCRNOTSUPP	Encryption method not supported.
ErrRDONLY	Read-only archive.
ErrNOPASSWD	No password provided.
ErrWRONGPASSWD	Wrong password provided.

Instances

Enum ZipError #
Methods succ :: ZipError -> ZipError # pred :: ZipError -> ZipError # toEnum :: Int -> ZipError # fromEnum :: ZipError -> Int # enumFrom :: ZipError -> [ZipError] # enumFromThen :: ZipError -> ZipError -> [ZipError] # enumFromTo :: ZipError -> ZipError -> [ZipError] # enumFromThenTo :: ZipError -> ZipError -> ZipError -> [ZipError] #
Eq ZipError #
Methods (==) :: ZipError -> ZipError -> Bool # (/=) :: ZipError -> ZipError -> Bool #
Show ZipError #
Methods showsPrec :: Int -> ZipError -> ShowS # show :: ZipError -> String # showList :: [ZipError] -> ShowS #
Exception ZipError #
Methods toException :: ZipError -> SomeException # fromException :: SomeException -> Maybe ZipError # displayException :: ZipError -> String #

data ZipCompMethod #

Compression methods.

Constructors

CompDEFAULT	Better of deflate or store.
CompSTORE	Stored (uncompressed).
CompSHRINK	Shrunk.
CompREDUCE_1	Reduced with factor 1
CompREDUCE_2	Reduced with factor 2
CompREDUCE_3	Reduced with factor 3
CompREDUCE_4	Reduced with factor 4
CompIMPLODE	Imploded.
CompDEFLATE	Deflated.
CompDEFLATE64	Deflate64.
CompPKWARE_IMPLODE	PKWARE imploding.
CompBZIP2	Compressed using BZIP2 algorithm.
CompLZMA	LZMA (EFS)
CompTERSE	Compressed using IBM TERSE (new).
CompLZ77	IBM LZ77 z Architecture (PFS).
CompWAVPACK	WavPack compressed data.
CompPPMD	PPMd version I, Rev 1.

Instances

Enum ZipCompMethod #
Methods succ :: ZipCompMethod -> ZipCompMethod # pred :: ZipCompMethod -> ZipCompMethod # toEnum :: Int -> ZipCompMethod # fromEnum :: ZipCompMethod -> Int # enumFrom :: ZipCompMethod -> [ZipCompMethod] # enumFromThen :: ZipCompMethod -> ZipCompMethod -> [ZipCompMethod] # enumFromTo :: ZipCompMethod -> ZipCompMethod -> [ZipCompMethod] # enumFromThenTo :: ZipCompMethod -> ZipCompMethod -> ZipCompMethod -> [ZipCompMethod] #
Eq ZipCompMethod #
Methods (==) :: ZipCompMethod -> ZipCompMethod -> Bool # (/=) :: ZipCompMethod -> ZipCompMethod -> Bool #
Show ZipCompMethod #
Methods showsPrec :: Int -> ZipCompMethod -> ShowS # show :: ZipCompMethod -> String # showList :: [ZipCompMethod] -> ShowS #

data ZipEncryptionMethod #

Encryption methods.

Constructors

EncryptNONE	Not encrypted.
EncryptTRAD_PKWARE	Traditional PKWARE encryption.
EncryptUNKNOWN	Unknown algorithm.

Instances

Enum ZipEncryptionMethod #
Methods succ :: ZipEncryptionMethod -> ZipEncryptionMethod # pred :: ZipEncryptionMethod -> ZipEncryptionMethod # toEnum :: Int -> ZipEncryptionMethod # fromEnum :: ZipEncryptionMethod -> Int # enumFrom :: ZipEncryptionMethod -> [ZipEncryptionMethod] # enumFromThen :: ZipEncryptionMethod -> ZipEncryptionMethod -> [ZipEncryptionMethod] # enumFromTo :: ZipEncryptionMethod -> ZipEncryptionMethod -> [ZipEncryptionMethod] # enumFromThenTo :: ZipEncryptionMethod -> ZipEncryptionMethod -> ZipEncryptionMethod -> [ZipEncryptionMethod] #
Eq ZipEncryptionMethod #
Methods (==) :: ZipEncryptionMethod -> ZipEncryptionMethod -> Bool # (/=) :: ZipEncryptionMethod -> ZipEncryptionMethod -> Bool #
Show ZipEncryptionMethod #
Methods showsPrec :: Int -> ZipEncryptionMethod -> ShowS # show :: ZipEncryptionMethod -> String # showList :: [ZipEncryptionMethod] -> ShowS #

combine :: (Enum a, Num b) => [a] -> b #