| 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
- 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
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
| Show TarException Source # | |
Defined in Data.Conduit.Tar.Types Methods showsPrec :: Int -> TarException -> ShowS # show :: TarException -> String # showList :: [TarException] -> ShowS # | |
| Exception TarException Source # | |
Defined in Data.Conduit.Tar.Types Methods toException :: TarException -> SomeException # fromException :: SomeException -> Maybe TarException # displayException :: TarException -> String # | |
data TarCreateException Source #
Constructors
| FileNameTooLong !FileInfo | |
| TarCreationError !String |
Instances
| Show TarCreateException Source # | |
Defined in Data.Conduit.Tar.Types Methods showsPrec :: Int -> TarCreateException -> ShowS # show :: TarCreateException -> String # showList :: [TarCreateException] -> ShowS # | |
| Exception TarCreateException Source # | |
Defined in Data.Conduit.Tar.Types Methods toException :: TarCreateException -> SomeException # fromException :: SomeException -> Maybe TarCreateException # | |
Constructors
| FTNormal | |
| FTHardLink !ByteString | |
| FTSymbolicLink !ByteString | |
| FTCharacterSpecial | |
| FTBlockSpecial | |
| FTDirectory | |
| FTFifo | |
| FTOther !Word8 |
Constructors
| FileInfo | |
Fields
| |
type FileOffset = COff #
Instances
| Bounded CUid | |
| Enum CUid | |
| Eq CUid | |
| Integral CUid | |
| Num CUid | |
| Ord CUid | |
| Read CUid | |
| Real CUid | |
Defined in System.Posix.Types Methods toRational :: CUid -> Rational # | |
| Show CUid | |
| Storable CUid | |
Defined in System.Posix.Types | |
| Bits CUid | |
Defined in System.Posix.Types Methods (.&.) :: CUid -> CUid -> CUid # (.|.) :: CUid -> CUid -> CUid # complement :: CUid -> CUid # shift :: CUid -> Int -> CUid # rotate :: CUid -> Int -> CUid # setBit :: CUid -> Int -> CUid # clearBit :: CUid -> Int -> CUid # complementBit :: CUid -> Int -> CUid # testBit :: CUid -> Int -> Bool # bitSizeMaybe :: CUid -> Maybe Int # shiftL :: CUid -> Int -> CUid # unsafeShiftL :: CUid -> Int -> CUid # shiftR :: CUid -> Int -> CUid # unsafeShiftR :: CUid -> Int -> CUid # rotateL :: CUid -> Int -> CUid # | |
| FiniteBits CUid | |
Defined in System.Posix.Types Methods finiteBitSize :: CUid -> Int # countLeadingZeros :: CUid -> Int # countTrailingZeros :: CUid -> Int # | |
Instances
| Bounded CGid | |
| Enum CGid | |
| Eq CGid | |
| Integral CGid | |
| Num CGid | |
| Ord CGid | |
| Read CGid | |
| Real CGid | |
Defined in System.Posix.Types Methods toRational :: CGid -> Rational # | |
| Show CGid | |
| Storable CGid | |
Defined in System.Posix.Types | |
| Bits CGid | |
Defined in System.Posix.Types Methods (.&.) :: CGid -> CGid -> CGid # (.|.) :: CGid -> CGid -> CGid # complement :: CGid -> CGid # shift :: CGid -> Int -> CGid # rotate :: CGid -> Int -> CGid # setBit :: CGid -> Int -> CGid # clearBit :: CGid -> Int -> CGid # complementBit :: CGid -> Int -> CGid # testBit :: CGid -> Int -> Bool # bitSizeMaybe :: CGid -> Maybe Int # shiftL :: CGid -> Int -> CGid # unsafeShiftL :: CGid -> Int -> CGid # shiftR :: CGid -> Int -> CGid # unsafeShiftR :: CGid -> Int -> CGid # rotateL :: CGid -> Int -> CGid # | |
| FiniteBits CGid | |
Defined in System.Posix.Types Methods finiteBitSize :: CGid -> Int # countLeadingZeros :: CGid -> Int # countTrailingZeros :: CGid -> Int # | |
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.