Data.Conduit.Tar.Types

Module contains all the types necessary for tarball processing.

Documentation

data Header

Constructors

Header

Fields

• headerOffset :: !FileOffset
• headerPayloadOffset :: !FileOffset
• headerFileNameSuffix :: !ShortByteString
• headerFileMode :: !CMode
• headerOwnerId :: !UserID
• headerGroupId :: !GroupID
• headerPayloadSize :: !FileOffset
• headerTime :: !EpochTime
• headerLinkIndicator :: !Word8
• headerLinkName :: !ShortByteString
• headerMagicVersion :: !ShortByteString
• headerOwnerName :: !ShortByteString
• headerGroupName :: !ShortByteString
• headerDeviceMajor :: !DeviceID
• headerDeviceMinor :: !DeviceID
• headerFileNamePrefix :: !ShortByteString

Instances

Show Header

Methods

showsPrec :: Int -> Header -> ShowS

show :: Header -> String

showList :: [Header] -> ShowS

data TarChunk

Constructors

ChunkHeader Header

ChunkPayload !FileOffset !ByteString

ChunkException TarException

Instances

Show TarChunk

Methods

showsPrec :: Int -> TarChunk -> ShowS

show :: TarChunk -> String

showList :: [TarChunk] -> ShowS

data TarException

This the the exception type that is used in this module.

More constructors are susceptible to be added without bumping the major version of this module.

Constructors

NoMoreHeaders

UnexpectedPayload !FileOffset

IncompleteHeader !FileOffset

IncompletePayload !FileOffset !ByteCount

ShortTrailer !FileOffset

BadTrailer !FileOffset

InvalidHeader !FileOffset

BadChecksum !FileOffset

FileTypeError !FileOffset !Char !String

Instances

Show TarException

Methods

showsPrec :: Int -> TarException -> ShowS

show :: TarException -> String

showList :: [TarException] -> ShowS

Exception TarException

Methods

toException :: TarException -> SomeException

fromException :: SomeException -> Maybe TarException

displayException :: TarException -> String

data TarCreateException

Constructors

FileNameTooLong !FileInfo

TarCreationError !String

Instances

Show TarCreateException

Methods

showsPrec :: Int -> TarCreateException -> ShowS

show :: TarCreateException -> String

showList :: [TarCreateException] -> ShowS

Exception TarCreateException

Methods

toException :: TarCreateException -> SomeException

fromException :: SomeException -> Maybe TarCreateException

displayException :: TarCreateException -> String

data FileType

Constructors

FTNormal

FTHardLink

FTSymbolicLink !ByteString

FTCharacterSpecial

FTBlockSpecial

FTDirectory

FTFifo

FTOther !Word8

Instances

Eq FileType

Methods

(==) :: FileType -> FileType -> Bool

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

Show FileType

Methods

showsPrec :: Int -> FileType -> ShowS

show :: FileType -> String

showList :: [FileType] -> ShowS

data FileInfo

Constructors

FileInfo

Fields

• filePath :: !ByteString

  File path.

• fileUserId :: !UserID

  Unix user id.

• fileUserName :: !ByteString

  Unix user name.

• fileGroupId :: !GroupID

  Unix group id.

• fileGroupName :: !ByteString

  Unix group name.

• fileMode :: !FileMode

  Unix file permissions

• fileSize :: !FileOffset

  File size

• fileType :: !FileType

  File type. FTNormal, FTSymbolicLink and FTDirectory are the only ones supported for now

• fileModTime :: !EpochTime

  File modification timestamp

Instances

Eq FileInfo

Methods

(==) :: FileInfo -> FileInfo -> Bool

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

Show FileInfo

Methods

showsPrec :: Int -> FileInfo -> ShowS

show :: FileInfo -> String

showList :: [FileInfo] -> ShowS

type FileOffset = COff

type ByteCount = CSize

type UserID = CUid

type GroupID = CGid

type DeviceID = CDev

type EpochTime = CTime