Codec.Archive.Zip.Type

Types used by the package. You don't usually need to import this module, because Codec.Archive.Zip re-exports everything you may need, import that module instead.

Entry selector

data EntrySelector

This data type serves for naming and selection of archive entries. It can be created only with the help of the smart constructor mkEntrySelector, and it's the only “key” that can be used to select files in archive or to name new files.

The abstraction is crucial for ensuring that created archives are portable across operating systems, file systems, and different platforms. Since on some operating systems, file paths are case-insensitive, this selector is also case-insensitive. It makes sure that only relative paths are used to name files inside archive, as it's recommended in the specification. It also guarantees that forward slashes are used when the path is stored inside archive for compatibility with Unix-like operating systems (as it is recommended in the specification). On the other hand, in can be rendered as ordinary relative file path in OS-specific format, when needed.

Instances

Eq EntrySelector

Methods

(==) :: EntrySelector -> EntrySelector -> Bool

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

Data EntrySelector

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> EntrySelector -> c EntrySelector

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c EntrySelector

toConstr :: EntrySelector -> Constr

dataTypeOf :: EntrySelector -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c EntrySelector)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c EntrySelector)

gmapT :: (forall b. Data b => b -> b) -> EntrySelector -> EntrySelector

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> EntrySelector -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> EntrySelector -> r

gmapQ :: (forall d. Data d => d -> u) -> EntrySelector -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> EntrySelector -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> EntrySelector -> m EntrySelector

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> EntrySelector -> m EntrySelector

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> EntrySelector -> m EntrySelector

Ord EntrySelector

Methods

compare :: EntrySelector -> EntrySelector -> Ordering

(<) :: EntrySelector -> EntrySelector -> Bool

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

(>) :: EntrySelector -> EntrySelector -> Bool

(>=) :: EntrySelector -> EntrySelector -> Bool

max :: EntrySelector -> EntrySelector -> EntrySelector

min :: EntrySelector -> EntrySelector -> EntrySelector

Show EntrySelector

Methods

showsPrec :: Int -> EntrySelector -> ShowS

show :: EntrySelector -> String

showList :: [EntrySelector] -> ShowS

Generic EntrySelector

Associated Types

type Rep EntrySelector :: * -> *

Methods

from :: EntrySelector -> Rep EntrySelector x

to :: Rep EntrySelector x -> EntrySelector

type Rep EntrySelector

type Rep EntrySelector = D1 (MetaData "EntrySelector" "Codec.Archive.Zip.Type" "zip-0.1.10-25VzKDgLqXNJGXynIdbCNk" True) (C1 (MetaCons "EntrySelector" PrefixI True) (S1 (MetaSel (Just Symbol "unES") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (NonEmpty (CI String)))))

mkEntrySelector :: MonadThrow m => Path Rel File -> m EntrySelector

Create an EntrySelector from Path Rel File. To avoid problems with distribution of the archive, characters that some operating systems do not expect in paths are not allowed. Proper paths should pass these checks:

• isValid
• isValid
• binary representation of normalized path should be not longer than 65535 bytes

This function can throw EntrySelectorException exception.

unEntrySelector :: EntrySelector -> Path Rel File

Make a relative path from EntrySelector. Every EntrySelector produces single Path Rel File that corresponds to it.

getEntryName :: EntrySelector -> Text

Get entry name given EntrySelector in the from that is suitable for writing to file header.

data EntrySelectorException

The exception describing various troubles you can have with EntrySelector.

Constructors

InvalidEntrySelector (Path Rel File)

Selector cannot be created from this path

Instances

Eq EntrySelectorException

Methods

(==) :: EntrySelectorException -> EntrySelectorException -> Bool

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

Ord EntrySelectorException

Methods

compare :: EntrySelectorException -> EntrySelectorException -> Ordering

(<) :: EntrySelectorException -> EntrySelectorException -> Bool

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

(>) :: EntrySelectorException -> EntrySelectorException -> Bool

(>=) :: EntrySelectorException -> EntrySelectorException -> Bool

max :: EntrySelectorException -> EntrySelectorException -> EntrySelectorException

min :: EntrySelectorException -> EntrySelectorException -> EntrySelectorException

Show EntrySelectorException

Methods

showsPrec :: Int -> EntrySelectorException -> ShowS

show :: EntrySelectorException -> String

showList :: [EntrySelectorException] -> ShowS

Exception EntrySelectorException

Methods

toException :: EntrySelectorException -> SomeException

fromException :: SomeException -> Maybe EntrySelectorException

displayException :: EntrySelectorException -> String

Entry description

data EntryDescription

This record represents all information about archive entry that can be stored in a zip archive. It does not mirror local file header or central directory file header, but their binary representation can be built given this date structure and actual archive contents.

Constructors

EntryDescription

Fields

• edVersionMadeBy :: Version

  Version made by

• edVersionNeeded :: Version

  Version needed to extract

• edCompression :: CompressionMethod

  Compression method

• edModTime :: UTCTime

  Last modification date and time

• edCRC32 :: Word32

  CRC32 check sum

• edCompressedSize :: Natural

  Size of compressed entry

• edUncompressedSize :: Natural

  Size of uncompressed entry

• edOffset :: Natural

  Absolute offset of local file header

• edComment :: Maybe Text

  Entry comment

• edExtraField :: Map Word16 ByteString

  All extra fields found

Instances

Eq EntryDescription

Methods

(==) :: EntryDescription -> EntryDescription -> Bool

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

data CompressionMethod

Supported compression methods.

Constructors

Store

Store file uncompressed

Deflate

Deflate

BZip2

Compressed using BZip2 algorithm

Instances

Bounded CompressionMethod

Methods

minBound :: CompressionMethod

maxBound :: CompressionMethod

Enum CompressionMethod

Methods

succ :: CompressionMethod -> CompressionMethod

pred :: CompressionMethod -> CompressionMethod

toEnum :: Int -> CompressionMethod

fromEnum :: CompressionMethod -> Int

enumFrom :: CompressionMethod -> [CompressionMethod]

enumFromThen :: CompressionMethod -> CompressionMethod -> [CompressionMethod]

enumFromTo :: CompressionMethod -> CompressionMethod -> [CompressionMethod]

enumFromThenTo :: CompressionMethod -> CompressionMethod -> CompressionMethod -> [CompressionMethod]

Eq CompressionMethod

Methods

(==) :: CompressionMethod -> CompressionMethod -> Bool

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

Data CompressionMethod

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CompressionMethod -> c CompressionMethod

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CompressionMethod

toConstr :: CompressionMethod -> Constr

dataTypeOf :: CompressionMethod -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CompressionMethod)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CompressionMethod)

gmapT :: (forall b. Data b => b -> b) -> CompressionMethod -> CompressionMethod

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CompressionMethod -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CompressionMethod -> r

gmapQ :: (forall d. Data d => d -> u) -> CompressionMethod -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CompressionMethod -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CompressionMethod -> m CompressionMethod

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CompressionMethod -> m CompressionMethod

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CompressionMethod -> m CompressionMethod

Ord CompressionMethod

Methods

compare :: CompressionMethod -> CompressionMethod -> Ordering

(<) :: CompressionMethod -> CompressionMethod -> Bool

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

(>) :: CompressionMethod -> CompressionMethod -> Bool

(>=) :: CompressionMethod -> CompressionMethod -> Bool

max :: CompressionMethod -> CompressionMethod -> CompressionMethod

min :: CompressionMethod -> CompressionMethod -> CompressionMethod

Read CompressionMethod

Methods

readsPrec :: Int -> ReadS CompressionMethod

readList :: ReadS [CompressionMethod]

readPrec :: ReadPrec CompressionMethod

readListPrec :: ReadPrec [CompressionMethod]

Show CompressionMethod

Methods

showsPrec :: Int -> CompressionMethod -> ShowS

show :: CompressionMethod -> String

showList :: [CompressionMethod] -> ShowS

Archive desrciption

data ArchiveDescription

Information about archive as a whole.

Constructors

ArchiveDescription

Fields

• adComment :: Maybe Text

  Comment of entire archive

• adCDOffset :: Natural

  Absolute offset of start of central directory

• adCDSize :: Natural

  Size of central directory record

Instances

Eq ArchiveDescription

Methods

(==) :: ArchiveDescription -> ArchiveDescription -> Bool

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

Data ArchiveDescription

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ArchiveDescription -> c ArchiveDescription

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ArchiveDescription

toConstr :: ArchiveDescription -> Constr

dataTypeOf :: ArchiveDescription -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ArchiveDescription)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ArchiveDescription)

gmapT :: (forall b. Data b => b -> b) -> ArchiveDescription -> ArchiveDescription

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ArchiveDescription -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ArchiveDescription -> r

gmapQ :: (forall d. Data d => d -> u) -> ArchiveDescription -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ArchiveDescription -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ArchiveDescription -> m ArchiveDescription

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ArchiveDescription -> m ArchiveDescription

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ArchiveDescription -> m ArchiveDescription

Ord ArchiveDescription

Methods

compare :: ArchiveDescription -> ArchiveDescription -> Ordering

(<) :: ArchiveDescription -> ArchiveDescription -> Bool

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

(>) :: ArchiveDescription -> ArchiveDescription -> Bool

(>=) :: ArchiveDescription -> ArchiveDescription -> Bool

max :: ArchiveDescription -> ArchiveDescription -> ArchiveDescription

min :: ArchiveDescription -> ArchiveDescription -> ArchiveDescription

Read ArchiveDescription

Methods

readsPrec :: Int -> ReadS ArchiveDescription

readList :: ReadS [ArchiveDescription]

readPrec :: ReadPrec ArchiveDescription

readListPrec :: ReadPrec [ArchiveDescription]

Show ArchiveDescription

Methods

showsPrec :: Int -> ArchiveDescription -> ShowS

show :: ArchiveDescription -> String

showList :: [ArchiveDescription] -> ShowS

Exceptions

data ZipException

The bad things that can happen when you use the library.

Constructors

EntryDoesNotExist (Path Abs File) EntrySelector

Thrown when you try to get contents of non-existing entry

ParsingFailed (Path Abs File) String

Thrown when archive structure cannot be parsed

Instances

Eq ZipException

Methods

(==) :: ZipException -> ZipException -> Bool

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

Ord ZipException

Methods

compare :: ZipException -> ZipException -> Ordering

(<) :: ZipException -> ZipException -> Bool

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

(>) :: ZipException -> ZipException -> Bool

(>=) :: ZipException -> ZipException -> Bool

max :: ZipException -> ZipException -> ZipException

min :: ZipException -> ZipException -> ZipException

Show ZipException

Methods

showsPrec :: Int -> ZipException -> ShowS

show :: ZipException -> String

showList :: [ZipException] -> ShowS

Exception ZipException

Methods

toException :: ZipException -> SomeException

fromException :: SomeException -> Maybe ZipException

displayException :: ZipException -> String