| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
Data.Conduit.Tar.Types
Description
Module contains all the types necessary for tarball processing.
Synopsis
- data Header = Header {
- 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
- type PaxHeader = Map ByteString ByteString
- data PaxState = PaxState PaxHeader PaxHeader
- initialPaxState :: PaxState
- data TarChunk
- data TarException
- data TarCreateException
- data FileType
- data FileInfo = FileInfo {
- filePath :: !ByteString
- fileUserId :: !UserID
- fileUserName :: !ByteString
- fileGroupId :: !GroupID
- fileGroupName :: !ByteString
- fileMode :: !FileMode
- fileSize :: !FileOffset
- fileType :: !FileType
- fileModTime :: !EpochTime
- type FileOffset = COff
- type ByteCount = CSize
- type UserID = CUid
- type GroupID = CGid
- type DeviceID = CDev
- type EpochTime = CTime
- newtype CUid = CUid Word32
- newtype CGid = CGid Word32
- encodeFilePath :: FilePath -> ByteString
- decodeFilePath :: ByteString -> FilePath
- getFileInfoPath :: FileInfo -> FilePath
Documentation
Constructors
type PaxHeader = Map ByteString ByteString Source #
Type synonym representing a pax extended header.
Type representing states (global, next file) given pax extended headers.
initialPaxState :: PaxState Source #
The initial state before applying any pax extended headers.
Constructors
| ChunkHeader Header | |
| ChunkPayload !FileOffset !ByteString | |
| ChunkException TarException |
data TarException Source #
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
Instances
| Exception TarException Source # | |
Defined in Data.Conduit.Tar.Types Methods toException :: TarException -> SomeException Source # fromException :: SomeException -> Maybe TarException Source # displayException :: TarException -> String Source # backtraceDesired :: TarException -> Bool Source # | |
| Show TarException Source # | |
Defined in Data.Conduit.Tar.Types | |
data TarCreateException Source #
Constructors
| FileNameTooLong !FileInfo | |
| TarCreationError !String |
Instances
| Exception TarCreateException Source # | |
Defined in Data.Conduit.Tar.Types | |
| Show TarCreateException Source # | |
Defined in Data.Conduit.Tar.Types | |
Constructors
| FTNormal | |
| FTHardLink !ByteString | |
| FTSymbolicLink !ByteString | |
| FTCharacterSpecial | |
| FTBlockSpecial | |
| FTDirectory | |
| FTFifo | |
| FTOther !Word8 |
Constructors
| FileInfo | |
Fields
| |
type FileOffset = COff Source #
Instances
Instances
encodeFilePath :: FilePath -> ByteString Source #
Convert FilePath into a UTF-8 encoded ByteString
decodeFilePath :: ByteString -> FilePath Source #
Convert UTF-8 encoded ByteString back into the FilePath.