Streamly.External.Zip.Internal

Documentation

newtype Zip

A zip archive.

Constructors

Zip (ForeignPtr Zip_t)

data OpenFlag

Constructors

O_CHECKCONS

Perform additional stricter consistency checks on the archive, and error if they fail.

Instances

Eq OpenFlag

Defined in Streamly.External.Zip.Internal

Methods

(==) :: OpenFlag -> OpenFlag -> Bool

(/=) :: OpenFlag -> OpenFlag -> Bool

Ord OpenFlag

Defined in Streamly.External.Zip.Internal

Methods

compare :: OpenFlag -> OpenFlag -> Ordering

(<) :: OpenFlag -> OpenFlag -> Bool

(<=) :: OpenFlag -> OpenFlag -> Bool

(>) :: OpenFlag -> OpenFlag -> Bool

(>=) :: OpenFlag -> OpenFlag -> Bool

max :: OpenFlag -> OpenFlag -> OpenFlag

min :: OpenFlag -> OpenFlag -> OpenFlag

openFlags :: Map OpenFlag CInt

Internal.

openZip :: FilePath -> [OpenFlag] -> IO Zip

Opens the zip archive at the given file path.

Warning: To satisfy low-level libzip requirements, please use each Zip from one thread only—or make sure to synchronize its use. Note that it is perfectly fine to open multiple Zips for a single zip file on disk.

getNumEntries :: Zip -> IO Int

Gets the number of entries in the given archive.

data PathFlag

Constructors

P_FL_ENC_RAW

Return the unmodified names as it is in the ZIP archive.

P_FL_ENC_GUESS

(Default.) Guess the encoding of the name in the ZIP archive and convert it to UTF-8, if necessary. (Only CP-437 and UTF-8 are recognized.)

P_FL_ENC_STRICT

Follow the ZIP specification and expect CP-437 encoded names in the ZIP archive (except if they are explicitly marked as UTF-8). Convert it to UTF-8.

Instances

Eq PathFlag

Defined in Streamly.External.Zip.Internal

Methods

(==) :: PathFlag -> PathFlag -> Bool

(/=) :: PathFlag -> PathFlag -> Bool

Ord PathFlag

Defined in Streamly.External.Zip.Internal

Methods

compare :: PathFlag -> PathFlag -> Ordering

(<) :: PathFlag -> PathFlag -> Bool

(<=) :: PathFlag -> PathFlag -> Bool

(>) :: PathFlag -> PathFlag -> Bool

(>=) :: PathFlag -> PathFlag -> Bool

max :: PathFlag -> PathFlag -> PathFlag

min :: PathFlag -> PathFlag -> PathFlag

pathFlags :: Map PathFlag Zip_flags_t

Internal.

getPathByIndex :: Zip -> Int -> [PathFlag] -> IO ByteString

Gets the path (e.g., "foo.txt", "foo/", or "foo/bar.txt") of the file at the given 0-based index in the given zip archive. Please use getNumEntries to find the upper bound for the index.

data File

A file inside of a Zip archive.

Internal.

Constructors

File !(Ptr Zip_file_t) !IOFinalizer

data GetFileFlag

Constructors

GF_FL_COMPRESSED

Read the compressed data. Otherwise the data is uncompressed when reading.

Instances

Eq GetFileFlag

Defined in Streamly.External.Zip.Internal

Methods

(==) :: GetFileFlag -> GetFileFlag -> Bool

(/=) :: GetFileFlag -> GetFileFlag -> Bool

Ord GetFileFlag

Defined in Streamly.External.Zip.Internal

Methods

compare :: GetFileFlag -> GetFileFlag -> Ordering

(<) :: GetFileFlag -> GetFileFlag -> Bool

(<=) :: GetFileFlag -> GetFileFlag -> Bool

(>) :: GetFileFlag -> GetFileFlag -> Bool

(>=) :: GetFileFlag -> GetFileFlag -> Bool

max :: GetFileFlag -> GetFileFlag -> GetFileFlag

min :: GetFileFlag -> GetFileFlag -> GetFileFlag

getFileFlags :: Map GetFileFlag Zip_flags_t

getFileByPathOrIndex :: Zip -> [GetFileFlag] -> Either String Int -> IO File

We don't publicly expose getting a File (and then unfolding from it) because we don't want users to unfold from the same File more than once. (libzip’s c_zip_fread isn’t designed for iterating through a file more than once.)

Internal.

unfoldFile :: MonadIO m => Unfold m (Zip, [GetFileFlag], Either String Int) ByteString

chunkSize :: Zip_uint64_t

combineFlags :: (Ord flagType, Bits a, Num a) => Map flagType a -> [flagType] -> a

unfoldFileAtPath :: MonadIO m => Unfold m (Zip, [GetFileFlag], String) ByteString

Creates an Unfold with which one can stream data out of the entry at the given path (e.g., "foo.txt", "foo/", or "foo/bar.txt").

unfoldFileAtIndex :: MonadIO m => Unfold m (Zip, [GetFileFlag], Int) ByteString

Creates an Unfold with which one can stream data out of the entry at the given index. Please use getNumEntries to find the upper bound for the index.