Copyright	(c) 2007 Bjorn Bringert 2008 Andrea Vezzosi 2008-2009 Duncan Coutts 2011 Max Bolingbroke
License	BSD3
Maintainer	duncan@community.haskell.org
Portability	portable
Safe Haskell	Safe-Inferred
Language	Haskell2010

Codec.Archive.Tar.Read

Description

Synopsis

read :: ByteString -> Entries FormatError
data FormatError
- = TruncatedArchive
- | ShortTrailer
- | BadTrailer
- | TrailingJunk
- | ChecksumIncorrect
- | NotTarFormat
- | UnrecognisedTarFormat
- | HeaderBadNumericEncoding

Documentation

read :: ByteString -> Entries FormatError Source #

Convert a data stream in the tar file format into an internal data structure. Decoding errors are reported by the Fail constructor of the Entries type.

The conversion is done lazily.

data FormatError Source #

Errors that can be encountered when parsing a Tar archive.

Constructors

TruncatedArchive
ShortTrailer
BadTrailer
TrailingJunk
ChecksumIncorrect
NotTarFormat
UnrecognisedTarFormat
HeaderBadNumericEncoding

Instances

Instances details

Exception FormatError Source #
Instance details Defined in Codec.Archive.Tar.Read Methods toException :: FormatError -> SomeException # fromException :: SomeException -> Maybe FormatError # displayException :: FormatError -> String #
Show FormatError Source #
Instance details Defined in Codec.Archive.Tar.Read Methods showsPrec :: Int -> FormatError -> ShowS # show :: FormatError -> String # showList :: [FormatError] -> ShowS #
NFData FormatError Source #
Instance details Defined in Codec.Archive.Tar.Read Methods rnf :: FormatError -> () #
Eq FormatError Source #
Instance details Defined in Codec.Archive.Tar.Read Methods (==) :: FormatError -> FormatError -> Bool # (/=) :: FormatError -> FormatError -> Bool #