Copyright	© 2016–present Mark Karpov
License	BSD 3 clause
Maintainer	Mark Karpov <[email protected]>
Stability	experimental
Portability	portable
Safe Haskell	None
Language	GHC2021

Codec.Archive.Zip.Internal.Type

Contents

Entry selector
Entry description
Archive description
Exceptions

Description

Types used by the package.

Synopsis

data EntrySelector
mkEntrySelector :: MonadThrow m => FilePath -> m EntrySelector
unEntrySelector :: EntrySelector -> FilePath
getEntryName :: EntrySelector -> Text
newtype EntrySelectorException = InvalidEntrySelector FilePath
data EntryDescription = EntryDescription {
- edVersionMadeBy :: Version
- edVersionNeeded :: Version
- edCompression :: CompressionMethod
- edModTime :: UTCTime
- edCRC32 :: Word32
- edCompressedSize :: Natural
- edUncompressedSize :: Natural
- edOffset :: Natural
- edComment :: Maybe Text
- edExtraField :: Map Word16 ByteString
- edExternalFileAttrs :: Word32
}
data CompressionMethod
- = Store
- | Deflate
- | BZip2
- | Zstd
data ArchiveDescription = ArchiveDescription {
- adComment :: Maybe Text
- adCDOffset :: Natural
- adCDSize :: Natural
}
data ZipException

Entry selector

data EntrySelector Source #

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 refer to files in the archive or to name new archive entries.

The abstraction is crucial for ensuring that created archives are portable across operating systems, file systems, and 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 the archive for compatibility with Unix-like operating systems (as recommended in the specification). On the other hand, in can be rendered as an ordinary relative file path in OS-specific format when needed.

Instances

Instances details

Show EntrySelector Source #
Instance details Defined in Codec.Archive.Zip.Internal.Type Methods showsPrec :: Int -> EntrySelector -> ShowS # show :: EntrySelector -> String # showList :: [EntrySelector] -> ShowS #
Eq EntrySelector Source #
Instance details Defined in Codec.Archive.Zip.Internal.Type Methods (==) :: EntrySelector -> EntrySelector -> Bool # (/=) :: EntrySelector -> EntrySelector -> Bool #
Ord EntrySelector Source #
Instance details Defined in Codec.Archive.Zip.Internal.Type 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 #

mkEntrySelector :: MonadThrow m => FilePath -> m EntrySelector Source #

Create an EntrySelector from a FilePath. To avoid problems with distribution of the archive, characters that some operating systems do not expect in paths are not allowed.

Argument to mkEntrySelector should pass these checks:

isValid
isValid
it is a relative path without slash at the end
binary representations of normalized path should be not longer than 65535 bytes

This function can throw an EntrySelectorException.

unEntrySelector :: EntrySelector -> FilePath Source #

Restore a relative path from EntrySelector. Every EntrySelector corresponds to a FilePath.

getEntryName :: EntrySelector -> Text Source #

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

newtype EntrySelectorException Source #

The problems you can have with an EntrySelector.

Constructors

InvalidEntrySelector FilePath

EntrySelector cannot be created from this path

Instances

Instances details

Exception EntrySelectorException Source #
Instance details Defined in Codec.Archive.Zip.Internal.Type Methods toException :: EntrySelectorException -> SomeException # fromException :: SomeException -> Maybe EntrySelectorException # displayException :: EntrySelectorException -> String # backtraceDesired :: EntrySelectorException -> Bool #
Show EntrySelectorException Source #
Instance details Defined in Codec.Archive.Zip.Internal.Type Methods showsPrec :: Int -> EntrySelectorException -> ShowS # show :: EntrySelectorException -> String # showList :: [EntrySelectorException] -> ShowS #
Eq EntrySelectorException Source #
Instance details Defined in Codec.Archive.Zip.Internal.Type Methods (==) :: EntrySelectorException -> EntrySelectorException -> Bool # (/=) :: EntrySelectorException -> EntrySelectorException -> Bool #
Ord EntrySelectorException Source #
Instance details Defined in Codec.Archive.Zip.Internal.Type 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 #

Entry description

data EntryDescription Source #

The 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 representations can be built given this data structure and the 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
edExternalFileAttrs :: Word32
External file attributes
Since: 1.2.0

Instances

Instances details

Show EntryDescription Source #
Instance details Defined in Codec.Archive.Zip.Internal.Type Methods showsPrec :: Int -> EntryDescription -> ShowS # show :: EntryDescription -> String # showList :: [EntryDescription] -> ShowS #
Eq EntryDescription Source #
Instance details Defined in Codec.Archive.Zip.Internal.Type Methods (==) :: EntryDescription -> EntryDescription -> Bool # (/=) :: EntryDescription -> EntryDescription -> Bool #

data CompressionMethod Source #

The supported compression methods.

Constructors

Store	Store file uncompressed
Deflate	Deflate
BZip2	Compressed using BZip2 algorithm
Zstd	Compressed using Zstandard algorithm Since: 1.6.0

Instances

Instances details

Data CompressionMethod Source #
Instance details Defined in Codec.Archive.Zip.Internal.Type 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 :: forall r r'. (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 #
Bounded CompressionMethod Source #
Instance details Defined in Codec.Archive.Zip.Internal.Type Methods minBound :: CompressionMethod # maxBound :: CompressionMethod #
Enum CompressionMethod Source #
Instance details Defined in Codec.Archive.Zip.Internal.Type 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] #
Read CompressionMethod Source #
Instance details Defined in Codec.Archive.Zip.Internal.Type Methods readsPrec :: Int -> ReadS CompressionMethod # readList :: ReadS [CompressionMethod] # readPrec :: ReadPrec CompressionMethod # readListPrec :: ReadPrec [CompressionMethod] #
Show CompressionMethod Source #
Instance details Defined in Codec.Archive.Zip.Internal.Type Methods showsPrec :: Int -> CompressionMethod -> ShowS # show :: CompressionMethod -> String # showList :: [CompressionMethod] -> ShowS #
Eq CompressionMethod Source #
Instance details Defined in Codec.Archive.Zip.Internal.Type Methods (==) :: CompressionMethod -> CompressionMethod -> Bool # (/=) :: CompressionMethod -> CompressionMethod -> Bool #
Ord CompressionMethod Source #
Instance details Defined in Codec.Archive.Zip.Internal.Type 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 #

Archive description

data ArchiveDescription Source #

The information about the archive as a whole.

Constructors

ArchiveDescription
Fields adComment :: Maybe Text The comment of the entire archive adCDOffset :: Natural Absolute offset of the start of central directory adCDSize :: Natural The size of central directory record

Instances

Instances details

Data ArchiveDescription Source #
Instance details Defined in Codec.Archive.Zip.Internal.Type 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 :: forall r r'. (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 #
Read ArchiveDescription Source #
Instance details Defined in Codec.Archive.Zip.Internal.Type Methods readsPrec :: Int -> ReadS ArchiveDescription # readList :: ReadS [ArchiveDescription] # readPrec :: ReadPrec ArchiveDescription # readListPrec :: ReadPrec [ArchiveDescription] #
Show ArchiveDescription Source #
Instance details Defined in Codec.Archive.Zip.Internal.Type Methods showsPrec :: Int -> ArchiveDescription -> ShowS # show :: ArchiveDescription -> String # showList :: [ArchiveDescription] -> ShowS #
Eq ArchiveDescription Source #
Instance details Defined in Codec.Archive.Zip.Internal.Type Methods (==) :: ArchiveDescription -> ArchiveDescription -> Bool # (/=) :: ArchiveDescription -> ArchiveDescription -> Bool #
Ord ArchiveDescription Source #
Instance details Defined in Codec.Archive.Zip.Internal.Type 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 #

Exceptions

data ZipException Source #

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

Constructors

EntryDoesNotExist FilePath EntrySelector

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

UnsupportedCompressionMethod CompressionMethod

Thrown when attempting to decompress an entry compressed with an unsupported compression method or the library is compiled without support for it.

Since: 2.0.0

ParsingFailed FilePath String

Thrown when archive structure cannot be parsed.

Instances

Instances details

Exception ZipException Source #
Instance details Defined in Codec.Archive.Zip.Internal.Type Methods toException :: ZipException -> SomeException # fromException :: SomeException -> Maybe ZipException # displayException :: ZipException -> String # backtraceDesired :: ZipException -> Bool #
Show ZipException Source #
Instance details Defined in Codec.Archive.Zip.Internal.Type Methods showsPrec :: Int -> ZipException -> ShowS # show :: ZipException -> String # showList :: [ZipException] -> ShowS #
Eq ZipException Source #
Instance details Defined in Codec.Archive.Zip.Internal.Type Methods (==) :: ZipException -> ZipException -> Bool # (/=) :: ZipException -> ZipException -> Bool #
Ord ZipException Source #
Instance details Defined in Codec.Archive.Zip.Internal.Type 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 #