Codec.Archive.Foreign.Archive

This module corresponds to archive.h

Functions in this module are stateful and hence take place in the IO monad.

Documentation

archiveReadHasEncryptedEntries :: ArchivePtr -> IO ArchiveEncryption

Version information

archiveVersionNumber :: CInt

archiveVersionString :: String

archiveVersionDetails :: String

archiveZlibVersion :: IO CString

archiveLiblzmaVersion :: IO CString

archiveBzlibVersion :: IO CString

archiveLiblz4Version :: IO CString

archiveLibzstdVersion :: IO CString

Miscellany

archiveErrorString :: ArchivePtr -> IO CString

archiveFormatName :: ArchivePtr -> IO CString

archiveFormat :: ArchivePtr -> IO ArchiveFormat

archiveClearError :: ArchivePtr -> IO ()

archiveSetError :: ArchivePtr -> CInt -> CString -> IO ()

archiveCopyError :: ArchivePtr -> ArchivePtr -> IO ()

archiveFileCount :: ArchivePtr -> IO CInt

archiveFilterCount :: ArchivePtr -> IO CInt

archiveFilterBytes :: ArchivePtr -> CInt -> IO LaInt64

archiveFilterCode :: ArchivePtr -> CInt -> IO Int

archiveFilterName :: ArchivePtr -> CInt -> IO CString

Read

archiveReadData :: ArchivePtr -> Ptr a -> CSize -> IO LaSSize

archiveReadNew :: IO (Ptr Archive)

archiveReadSetOpenCallback :: ArchivePtr -> FunPtr (ArchiveOpenCallbackRaw a) -> IO ArchiveResult

archiveReadSetSeekCallback :: ArchivePtr -> FunPtr (ArchiveSeekCallback a) -> IO ArchiveResult

archiveReadSetSkipCallback :: ArchivePtr -> FunPtr (ArchiveSeekCallback a) -> IO ArchiveResult

archiveReadSetSwitchCallback :: ArchivePtr -> FunPtr (ArchiveSwitchCallbackRaw a n) -> IO ArchiveResult

archiveReadSetCallbackData2 :: ArchivePtr -> Ptr a -> CUInt -> IO ArchiveResult

archiveReadAddCallbackData :: ArchivePtr -> Ptr a -> CUInt -> IO ArchiveResult

archiveReadAppendCallbackData :: ArchivePtr -> Ptr a -> IO ArchiveResult

archiveReadPrependCallbackData :: ArchivePtr -> Ptr a -> IO ArchiveResult

archiveReadSetReadCallback :: ArchivePtr -> FunPtr (ArchiveReadCallback a b) -> IO ArchiveResult

archiveReadSetCloseCallback :: ArchivePtr -> FunPtr (ArchiveCloseCallbackRaw a) -> IO ArchiveResult

archiveReadSetCallbackData :: ArchivePtr -> Ptr a -> IO ArchiveResult

archiveReadSetFormat :: ArchivePtr -> ArchiveFormat -> IO ArchiveResult

archiveReadOpen :: ArchivePtr -> Ptr a -> FunPtr (ArchiveOpenCallbackRaw a) -> FunPtr (ArchiveReadCallback a b) -> FunPtr (ArchiveCloseCallbackRaw a) -> IO ArchiveResult

archiveReadOpenFilename :: ArchivePtr -> CString -> CSize -> IO ArchiveResult

archiveReadOpenFilenameW :: ArchivePtr -> CWString -> CSize -> IO ArchiveResult

archiveReadOpenFilenames :: ArchivePtr -> Ptr CString -> CSize -> IO ArchiveResult

archiveReadOpenMemory :: ArchivePtr -> Ptr a -> CSize -> IO ArchiveResult

archiveReadOpen1 :: ArchivePtr -> IO ArchiveResult

archiveReadOpen2 :: ArchivePtr -> Ptr a -> FunPtr (ArchiveOpenCallbackRaw a) -> FunPtr (ArchiveReadCallback a b) -> FunPtr (ArchiveSkipCallback a) -> FunPtr (ArchiveCloseCallbackRaw a) -> IO ArchiveResult

archiveReadOpenFd :: ArchivePtr -> Fd -> CSize -> IO ArchiveResult

archiveReadOpenFILE :: ArchivePtr -> FilePtr -> IO ArchiveResult

archiveReadNextHeader :: ArchivePtr -> IO (ArchiveResult, Ptr ArchiveEntry)

archiveReadNextHeader2 :: ArchivePtr -> ArchiveEntryPtr -> IO ArchiveResult

archiveReadHeaderPosition :: ArchivePtr -> IO LaInt64

archiveReadFormatCapabilities :: ArchivePtr -> IO ArchiveCapabilities

archiveSeekData :: ArchivePtr -> LaInt64 -> CInt -> IO LaInt64

archiveReadDataBlock :: ArchivePtr -> Ptr (Ptr a) -> Ptr CSize -> Ptr LaInt64 -> IO ArchiveResult

archiveReadDataIntoFd :: ArchivePtr -> Fd -> IO ArchiveResult

archiveReadSetFormatOption :: ArchivePtr -> CString -> CString -> CString -> IO ArchiveResult

archiveReadSetFilterOption :: ArchivePtr -> CString -> CString -> CString -> IO ArchiveResult

archiveReadSetOption :: ArchivePtr -> CString -> CString -> CString -> IO ArchiveResult

archiveReadSetOptions :: ArchivePtr -> CString -> IO ArchiveResult

archiveReadAddPassphrase :: ArchivePtr -> CString -> IO ArchiveResult

archiveReadSetPassphraseCallback :: ArchivePtr -> Ptr a -> FunPtr (ArchivePassphraseCallback a) -> IO ArchiveResult

archiveReadExtract :: ArchivePtr -> ArchiveEntryPtr -> Flags -> IO ArchiveResult

archiveReadExtract2 :: ArchivePtr -> ArchiveEntryPtr -> ArchivePtr -> IO ArchiveResult

archiveReadExtractSetProgressCallback :: ArchivePtr -> FunPtr (Ptr a -> IO ()) -> Ptr a -> IO ()

archiveReadExtractSetSkipFile :: ArchivePtr -> LaInt64 -> LaInt64 -> IO ()

archiveReadClose :: ArchivePtr -> IO ArchiveResult

archiveReadFree :: ArchivePtr -> IO ArchiveResult

archiveReadSupportFilterAll :: ArchivePtr -> IO ArchiveResult

archiveReadSupportFilterByCode :: ArchivePtr -> CInt -> IO ArchiveResult

archiveReadSupportFilterBzip2 :: ArchivePtr -> IO ArchiveResult

archiveReadSupportFilterCompress :: ArchivePtr -> IO ArchiveResult

archiveReadSupportFilterGzip :: ArchivePtr -> IO ArchiveResult

archiveReadSupportFilterGrzip :: ArchivePtr -> IO ArchiveResult

archiveReadSupportFilterLrzip :: ArchivePtr -> IO ArchiveResult

archiveReadSupportFilterLz4 :: ArchivePtr -> IO ArchiveResult

archiveReadSupportFilterLzip :: ArchivePtr -> IO ArchiveResult

archiveReadSupportFilterLzma :: ArchivePtr -> IO ArchiveResult

archiveReadSupportFilterLzop :: ArchivePtr -> IO ArchiveResult

archiveReadSupportFilterNone :: ArchivePtr -> IO ArchiveResult

archiveReadSupportFilterProgram :: ArchivePtr -> CString -> IO ArchiveResult

archiveReadSupportFilterProgramSignature :: ArchivePtr -> CString -> Ptr a -> CSize -> IO ArchiveResult

archiveReadSupportFilterRpm :: ArchivePtr -> IO ArchiveResult

archiveReadSupportFilterUu :: ArchivePtr -> IO ArchiveResult

archiveReadSupportFilterXz :: ArchivePtr -> IO ArchiveResult

archiveReadSupportFormatAll :: ArchivePtr -> IO ArchiveResult

archiveReadSupportFormat7zip :: ArchivePtr -> IO ArchiveResult

archiveReadSupportFormatAr :: ArchivePtr -> IO ArchiveResult

archiveReadSupportFormatByCode :: ArchivePtr -> CInt -> IO ArchiveResult

archiveReadSupportFormatCab :: ArchivePtr -> IO ArchiveResult

archiveReadSupportFormatCpio :: ArchivePtr -> IO ArchiveResult

archiveReadSupportFormatEmpty :: ArchivePtr -> IO ArchiveResult

archiveReadSupportFormatGnutar :: ArchivePtr -> IO ArchiveResult

archiveReadSupportFormatIso9660 :: ArchivePtr -> IO ArchiveResult

archiveReadSupportFormatLha :: ArchivePtr -> IO ArchiveResult

archiveReadSupportFormatMtree :: ArchivePtr -> IO ArchiveResult

archiveReadSupportFormatRar :: ArchivePtr -> IO ArchiveResult

archiveReadSupportFormatRar5 :: ArchivePtr -> IO ArchiveResult

archiveReadSupportFormatRaw :: ArchivePtr -> IO ArchiveResult

archiveReadSupportFormatTar :: ArchivePtr -> IO ArchiveResult

archiveReadSupportFormatWarc :: ArchivePtr -> IO ArchiveResult

archiveReadSupportFormatXar :: ArchivePtr -> IO ArchiveResult

archiveReadSupportFormatZip :: ArchivePtr -> IO ArchiveResult

archiveReadSupportFormatZipStreamable :: ArchivePtr -> IO ArchiveResult

archiveReadSupportFormatZipSeekable :: ArchivePtr -> IO ArchiveResult

archiveReadAppendFilter :: ArchivePtr -> CInt -> IO ArchiveResult

archiveReadAppendFilterProgram :: ArchivePtr -> CString -> IO ArchiveResult

archiveReadAppendFilterProgramSignature :: ArchivePtr -> CString -> Ptr a -> CSize -> IO ArchiveResult

Write

archiveWriteOpenMemory :: ArchivePtr -> Ptr a -> CSize -> IO (ArchiveResult, CSize)

archiveWriteNew :: IO (Ptr Archive)

archiveWriteData :: ArchivePtr -> Ptr a -> CSize -> IO LaSSize

archiveWriteOpen :: ArchivePtr -> Ptr a -> FunPtr (ArchiveOpenCallbackRaw a) -> FunPtr (ArchiveWriteCallback a b) -> FunPtr (ArchiveCloseCallbackRaw a) -> IO ArchiveResult

archiveWriteClose :: ArchivePtr -> IO ArchiveResult

archiveWriteHeader :: ArchivePtr -> ArchiveEntryPtr -> IO ArchiveResult

archiveWriteSetBytesPerBlock :: ArchivePtr -> CInt -> IO ArchiveResult

archiveWriteGetBytesPerBlock :: ArchivePtr -> IO CInt

archiveWriteSetBytesInLastBlock :: ArchivePtr -> CInt -> IO ArchiveResult

archiveWriteGetBytesInLastBlock :: ArchivePtr -> IO CInt

archiveWriteSetSkipFile :: ArchivePtr -> LaInt64 -> LaInt64 -> IO ArchiveResult

archiveWriteAddFilter :: ArchivePtr -> ArchiveFilter -> IO ArchiveResult

archiveWriteAddFilterByName :: ArchivePtr -> CString -> IO ArchiveResult

archiveWriteAddFilterB64encode :: ArchivePtr -> IO ArchiveResult

archiveWriteAddFilterBzip2 :: ArchivePtr -> IO ArchiveResult

archiveWriteAddFilterCompress :: ArchivePtr -> IO ArchiveResult

archiveWriteAddFilterGrzip :: ArchivePtr -> IO ArchiveResult

archiveWriteAddFilterLrzip :: ArchivePtr -> IO ArchiveResult

archiveWriteAddFilterLz4 :: ArchivePtr -> IO ArchiveResult

archiveWriteAddFilterLzma :: ArchivePtr -> IO ArchiveResult

archiveWriteAddFilterLzip :: ArchivePtr -> IO ArchiveResult

archiveWriteAddFilterLzop :: ArchivePtr -> IO ArchiveResult

archiveWriteAddFilterNone :: ArchivePtr -> IO ArchiveResult

archiveWriteAddFilterProgram :: ArchivePtr -> CString -> IO ArchiveResult

archiveWriteAddFilterUuencode :: ArchivePtr -> IO ArchiveResult

archiveWriteAddFilterXz :: ArchivePtr -> IO ArchiveResult

archiveWriteAddFilterZstd :: ArchivePtr -> IO ArchiveResult

archiveWriteSetFormat :: ArchivePtr -> ArchiveFormat -> IO ArchiveResult

archiveWriteSetFormatByName :: ArchivePtr -> CString -> IO ArchiveResult

archiveWriteSetFormatArBsd :: ArchivePtr -> IO ArchiveResult

archiveWriteSetFormatArSvr4 :: ArchivePtr -> IO ArchiveResult

archiveWriteSetFormatCpio :: ArchivePtr -> IO ArchiveResult

archiveWriteSetFormatCpioNewc :: ArchivePtr -> IO ArchiveResult

archiveWriteSetFormatGnutar :: ArchivePtr -> IO ArchiveResult

archiveWriteSetFormatMtree :: ArchivePtr -> IO ArchiveResult

archiveWriteSetFormatMtreeClassic :: ArchivePtr -> IO ArchiveResult

archiveWriteSetFormatPax :: ArchivePtr -> IO ArchiveResult

archiveWriteSetFormatPaxRestricted :: ArchivePtr -> IO ArchiveResult

archiveWriteSetFormatZip :: ArchivePtr -> IO ArchiveResult

archiveWriteSetFormat7zip :: ArchivePtr -> IO ArchiveResult

archiveWriteSetFormatRaw :: ArchivePtr -> IO ArchiveResult

archiveWriteSetFormatShar :: ArchivePtr -> IO ArchiveResult

archiveWriteSetFormatSharDump :: ArchivePtr -> IO ArchiveResult

archiveWriteSetFormatUstar :: ArchivePtr -> IO ArchiveResult

archiveWriteSetFormatV7tar :: ArchivePtr -> IO ArchiveResult

archiveWriteSetFormatWarc :: ArchivePtr -> IO ArchiveResult

archiveWriteSetFormatXar :: ArchivePtr -> IO ArchiveResult

archiveWriteSetFormatFilterByExt :: ArchivePtr -> CString -> IO ArchiveResult

archiveWriteSetFormatFilterByExtDef :: ArchivePtr -> CString -> CString -> IO ArchiveResult

archiveWriteZipSetCompressionDeflate :: ArchivePtr -> IO ArchiveResult

archiveWriteZipSetCompressionStore :: ArchivePtr -> IO ArchiveResult

archiveWriteOpen2 :: ArchivePtr -> Ptr a -> FunPtr (ArchiveOpenCallbackRaw a) -> FunPtr (ArchiveWriteCallback a b) -> FunPtr (ArchiveCloseCallbackRaw a) -> FunPtr (ArchiveFreeCallbackRaw a) -> IO ArchiveResult

archiveWriteOpenFd :: ArchivePtr -> Fd -> IO ArchiveResult

archiveWriteOpenFilenameW :: ArchivePtr -> CWString -> IO ArchiveResult

archiveWriteOpenFilename :: ArchivePtr -> CString -> IO ArchiveResult

archiveWriteOpenFILE :: ArchivePtr -> FilePtr -> IO ArchiveResult

archiveWriteDataBlock :: ArchivePtr -> Ptr a -> CSize -> LaInt64 -> IO LaSSize

archiveWriteFinishEntry :: ArchivePtr -> IO ArchiveResult

archiveWriteFail :: ArchivePtr -> IO ArchiveResult

archiveWriteFree :: ArchivePtr -> IO ArchiveResult

archiveWriteSetFormatOption :: ArchivePtr -> CString -> CString -> CString -> IO ArchiveResult

archiveWriteSetFilterOption :: ArchivePtr -> CString -> CString -> CString -> IO ArchiveResult

archiveWriteSetOption :: ArchivePtr -> CString -> CString -> CString -> IO ArchiveResult

archiveWriteSetOptions :: ArchivePtr -> CString -> IO ArchiveResult

archiveWriteSetPassphrase :: ArchivePtr -> CString -> IO ArchiveResult

archiveWriteSetPassphraseCallback :: ArchivePtr -> Ptr a -> FunPtr (ArchivePassphraseCallback a) -> IO ArchiveResult

Write disk

archiveWriteDiskSetOptions :: ArchivePtr -> Flags -> IO ArchiveResult

archiveWriteDiskNew :: IO (Ptr Archive)

archiveWriteDiskSetSkipFile :: ArchivePtr -> LaInt64 -> LaInt64 -> IO ArchiveResult

archiveWriteDiskSetStandardLookup :: ArchivePtr -> IO ArchiveResult

archiveWriteDiskSetGroupLookup :: ArchivePtr -> Ptr a -> FunPtr (Ptr a -> CString -> LaInt64 -> IO LaInt64) -> FunPtr (Ptr a -> IO ()) -> IO ArchiveResult

archiveWriteDiskSetUserLookup :: ArchivePtr -> Ptr a -> FunPtr (Ptr a -> CString -> LaInt64 -> IO LaInt64) -> FunPtr (Ptr a -> IO ()) -> IO ArchiveResult

archiveWriteDiskGid :: ArchivePtr -> CString -> LaInt64 -> IO LaInt64

archiveWriteDiskUid :: ArchivePtr -> CString -> LaInt64 -> IO LaInt64

Read disk

archiveReadDiskNew :: IO (Ptr Archive)

archiveReadDiskSetSymlinkLogical :: ArchivePtr -> IO ArchiveResult

archiveReadDiskSetSymlinkPhysical :: ArchivePtr -> IO ArchiveResult

archiveReadDiskSetSymlinkHybrid :: ArchivePtr -> IO ArchiveResult

archiveReadDiskEntryFromFile :: ArchivePtr -> ArchiveEntryPtr -> Fd -> StatPtr -> IO ArchiveResult

archiveReadDiskGname :: ArchivePtr -> LaInt64 -> IO CString

archiveReadDiskUname :: ArchivePtr -> LaInt64 -> IO CString

archiveReadDiskSetStandardLookup :: ArchivePtr -> IO ArchiveResult

archiveReadDiskSetGnameLookup :: ArchivePtr -> Ptr a -> FunPtr (Ptr a -> LaInt64 -> IO CString) -> FunPtr (Ptr a -> IO ()) -> IO ArchiveResult

archiveReadDiskSetUnameLookup :: ArchivePtr -> Ptr a -> FunPtr (Ptr a -> LaInt64 -> IO CString) -> FunPtr (Ptr a -> IO ()) -> IO ArchiveResult

archiveReadDiskOpen :: ArchivePtr -> CString -> IO ArchiveResult

archiveReadDiskOpenW :: ArchivePtr -> CWString -> IO ArchiveResult

archiveReadDiskDescend :: ArchivePtr -> IO ArchiveResult

archiveReadDiskCanDescend :: ArchivePtr -> IO Bool

archiveReadDiskCurrentFilesystem :: ArchivePtr -> IO CInt

archiveReadDiskCurrentFilesystemIsSynthetic :: ArchivePtr -> IO Bool

archiveReadDiskCurrentFilesystemIsRemote :: ArchivePtr -> IO Bool

archiveReadDiskSetAtimeRestored :: ArchivePtr -> IO ArchiveResult

archiveReadDiskSetBehavior :: ArchivePtr -> Flags -> IO ArchiveResult

archiveReadDiskSetMatching :: ArchivePtr -> ArchivePtr -> FunPtr (ArchivePtr -> Ptr a -> ArchiveEntryPtr -> IO ()) -> Ptr a -> IO ArchiveResult

archiveReadDiskSetMetadataFilterCallback :: ArchivePtr -> FunPtr (ArchivePtr -> Ptr a -> ArchiveEntry -> IO CInt) -> Ptr a -> IO ArchiveResult

archiveReadDiskNoAcl :: ReadDiskFlags

Since: 2.1.1.0

archiveReadDiskNoFFlags :: ReadDiskFlags

Since: 2.1.1.0

Version macros

archiveVersionNumberMacro :: Int

archiveVersionOnlyString :: String

archiveVersionStringMacro :: String

Capability macros

archiveReadFormatCapsNone :: ArchiveCapabilities

archiveReadFormatCapsEncryptData :: ArchiveCapabilities

archiveReadFormatCapsEncryptMetadata :: ArchiveCapabilities

Time matching macros

archiveMatchMTime :: TimeFlag

archiveMatchCTime :: TimeFlag

archiveMatchNewer :: TimeFlag

archiveMatchOlder :: TimeFlag

archiveMatchEqual :: TimeFlag

Entry flags

archiveExtractOwner :: Flags

archiveExtractPerm :: Flags

archiveExtractTime :: Flags

archiveExtractNoOverwrite :: Flags

archiveExtractUnlink :: Flags

archiveExtractACL :: Flags

archiveExtractFFlags :: Flags

archiveExtractXattr :: Flags

archiveExtractSecureSymlinks :: Flags

archiveExtractSecureNoDotDot :: Flags

archiveExtractNoAutodir :: Flags

archiveExtractSparse :: Flags

archiveExtractMacMetadata :: Flags

archiveExtractNoHfsCompression :: Flags

archiveExtractHfsCompressionForced :: Flags

archiveExtractSecureNoAbsolutePaths :: Flags

archiveExtractClearNoChangeFFlags :: Flags

archiveExtractNoOverwriteNewer :: Flags

Read disk flags

archiveReadDiskRestoreATime :: ReadDiskFlags

archiveReadDiskHonorNoDump :: ReadDiskFlags

archiveReadDiskMacCopyFile :: ReadDiskFlags

archiveReadDiskNoTraverseMounts :: ReadDiskFlags

archiveReadDiskNoXattr :: ReadDiskFlags

archiveFree :: Ptr Archive -> IO CInt

archiveEntryFree :: FinalizerPtr ()

archiveMatchExcluded :: ArchivePtr -> ArchiveEntryPtr -> IO Bool

archiveMatchPathExcluded :: ArchivePtr -> ArchiveEntryPtr -> IO Bool

archiveMatchSetInclusionRecursion :: ArchivePtr -> Bool -> IO ArchiveResult

archiveMatchExcludePattern :: ArchivePtr -> CString -> IO ArchiveResult

archiveMatchExcludePatternW :: ArchivePtr -> CWString -> IO ArchiveResult

archiveMatchIncludePattern :: ArchivePtr -> CString -> IO ArchiveResult

archiveMatchIncludePatternW :: ArchivePtr -> CWString -> IO ArchiveResult

archiveMatchExcludePatternFromFile :: ArchivePtr -> CString -> Bool -> IO ArchiveResult

archiveMatchExcludePatternFromFileW :: ArchivePtr -> CWString -> Bool -> IO ArchiveResult

archiveMatchIncludePatternFromFile :: ArchivePtr -> CString -> Bool -> IO ArchiveResult

archiveMatchIncludePatternFromFileW :: ArchivePtr -> CWString -> Bool -> IO ArchiveResult

archiveMatchPathUnmatchedInclusions :: ArchivePtr -> IO CInt

archiveMatchPathUnmatchedInclusionsNext :: ArchivePtr -> IO (ArchiveResult, CString)

archiveMatchPathUnmatchedInclusionsNextW :: ArchivePtr -> IO (ArchiveResult, CWString)

archiveMatchIncludeTime :: ArchivePtr -> TimeFlag -> CTime -> CLong -> IO ArchiveResult

archiveMatchIncludeDate :: ArchivePtr -> TimeFlag -> CString -> IO ArchiveResult

archiveMatchIncludeDateW :: ArchivePtr -> TimeFlag -> CWString -> IO ArchiveResult

archiveMatchIncludeFileTime :: ArchivePtr -> TimeFlag -> CString -> IO ArchiveResult

archiveMatchIncludeFileTimeW :: ArchivePtr -> TimeFlag -> CWString -> IO ArchiveResult

archiveMatchTimeExcluded :: ArchivePtr -> ArchiveEntryPtr -> IO Bool

archiveMatchOwnerExcluded :: ArchivePtr -> ArchiveEntryPtr -> IO Bool

archiveMatchExcludeEntry :: ArchivePtr -> TimeFlag -> ArchiveEntryPtr -> IO ArchiveResult

archiveReadDataSkip :: ArchivePtr -> IO ArchiveResult

archiveMatchIncludeGname :: ArchivePtr -> CString -> IO ArchiveResult

archiveMatchIncludeGnameW :: ArchivePtr -> CWString -> IO ArchiveResult

archiveMatchIncludeUname :: ArchivePtr -> CString -> IO ArchiveResult

archiveMatchIncludeUnameW :: ArchivePtr -> CWString -> IO ArchiveResult

archiveMatchIncludeUid :: ArchivePtr -> Id -> IO ArchiveResult

archiveMatchIncludeGid :: ArchivePtr -> Id -> IO ArchiveResult

archiveErrno :: ArchivePtr -> IO ArchiveResult

Abstract types

data Archive

Abstract type

Haskell types

data ArchiveEncryption

Constructors

HasEncryption

NoEncryption

EncryptionUnsupported

EncryptionUnknown

Instances

Eq ArchiveEncryption

Defined in Codec.Archive.Types

Methods

(==) :: ArchiveEncryption -> ArchiveEncryption -> Bool

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

C types

newtype FilePtr

FILE* in C

Constructors

FilePtr (Ptr FilePtr)

Enum types

data ArchiveFilter

Constructors

ArchiveFilterNone

ArchiveFilterGzip

ArchiveFilterBzip2

ArchiveFilterCompress

ArchiveFilterProgram

ArchiveFilterLzma

ArchiveFilterXz

ArchiveFilterUu

ArchiveFilterRpm

ArchiveFilterLzip

ArchiveFilterLrzip

ArchiveFilterLzop

ArchiveFilterGrzip

ArchiveFilterLz4

ArchiveFilterZstd

Instances

Enum ArchiveFilter

Defined in Codec.Archive.Types.Foreign

Methods

succ :: ArchiveFilter -> ArchiveFilter

pred :: ArchiveFilter -> ArchiveFilter

toEnum :: Int -> ArchiveFilter

fromEnum :: ArchiveFilter -> Int

enumFrom :: ArchiveFilter -> [ArchiveFilter]

enumFromThen :: ArchiveFilter -> ArchiveFilter -> [ArchiveFilter]

enumFromTo :: ArchiveFilter -> ArchiveFilter -> [ArchiveFilter]

enumFromThenTo :: ArchiveFilter -> ArchiveFilter -> ArchiveFilter -> [ArchiveFilter]

data ArchiveFormat

Constructors

ArchiveFormatCpio

ArchiveFormatCpioPosix

ArchiveFormatCpioBinLe

ArchiveFormatCpioBinBe

ArchiveFormatCpioSvr4Nocrc

ArchiveFormatCpioSvr4Crc

ArchiveFormatCpioAfioLarge

ArchiveFormatShar

ArchiveFormatSharBase

ArchiveFormatSharDump

ArchiveFormatTar

ArchiveFormatTarUstar

ArchiveFormatTarPaxInterchange

ArchiveFormatTarPaxRestricted

ArchiveFormatTarGnutar

ArchiveFormatIso9660

ArchiveFormatIso9660Rockridge

ArchiveFormatZip

ArchiveFormatEmpty

ArchiveFormatAr

ArchiveFormatArGnu

ArchiveFormatArBsd

ArchiveFormatMtree

ArchiveFormatRaw

ArchiveFormatXar

ArchiveFormatLha

ArchiveFormatCab

ArchiveFormatRar

ArchiveFormat7zip

ArchiveFormatWarc

ArchiveFormatRarV5

Instances

Enum ArchiveFormat

Defined in Codec.Archive.Types.Foreign

Methods

succ :: ArchiveFormat -> ArchiveFormat

pred :: ArchiveFormat -> ArchiveFormat

toEnum :: Int -> ArchiveFormat

fromEnum :: ArchiveFormat -> Int

enumFrom :: ArchiveFormat -> [ArchiveFormat]

enumFromThen :: ArchiveFormat -> ArchiveFormat -> [ArchiveFormat]

enumFromTo :: ArchiveFormat -> ArchiveFormat -> [ArchiveFormat]

enumFromThenTo :: ArchiveFormat -> ArchiveFormat -> ArchiveFormat -> [ArchiveFormat]

Eq ArchiveFormat

Defined in Codec.Archive.Types.Foreign

Methods

(==) :: ArchiveFormat -> ArchiveFormat -> Bool

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

Lower-level API types

data Flags

Instances

Semigroup Flags

Defined in Codec.Archive.Types.Foreign

Methods

(<>) :: Flags -> Flags -> Flags

sconcat :: NonEmpty Flags -> Flags

stimes :: Integral b => b -> Flags -> Flags

Monoid Flags

Defined in Codec.Archive.Types.Foreign

Methods

mempty :: Flags

mappend :: Flags -> Flags -> Flags

mconcat :: [Flags] -> Flags

data ArchiveCapabilities

Instances

Eq ArchiveCapabilities

Defined in Codec.Archive.Types.Foreign

Methods

(==) :: ArchiveCapabilities -> ArchiveCapabilities -> Bool

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

Semigroup ArchiveCapabilities

Defined in Codec.Archive.Types.Foreign

Methods

(<>) :: ArchiveCapabilities -> ArchiveCapabilities -> ArchiveCapabilities

sconcat :: NonEmpty ArchiveCapabilities -> ArchiveCapabilities

stimes :: Integral b => b -> ArchiveCapabilities -> ArchiveCapabilities

Monoid ArchiveCapabilities

Defined in Codec.Archive.Types.Foreign

Methods

mempty :: ArchiveCapabilities

mappend :: ArchiveCapabilities -> ArchiveCapabilities -> ArchiveCapabilities

mconcat :: [ArchiveCapabilities] -> ArchiveCapabilities

data ReadDiskFlags

Instances

Semigroup ReadDiskFlags

Defined in Codec.Archive.Types.Foreign

Methods

(<>) :: ReadDiskFlags -> ReadDiskFlags -> ReadDiskFlags

sconcat :: NonEmpty ReadDiskFlags -> ReadDiskFlags

stimes :: Integral b => b -> ReadDiskFlags -> ReadDiskFlags

data TimeFlag

Callback types

type ArchiveReadCallback a b = Ptr Archive -> Ptr a -> Ptr (Ptr b) -> IO LaSSize

type ArchiveSkipCallback a = Ptr Archive -> Ptr a -> LaInt64 -> IO LaInt64

type ArchiveSeekCallback a = Ptr Archive -> Ptr a -> LaInt64 -> CInt -> IO LaInt64

type ArchiveWriteCallback a b = Ptr Archive -> Ptr a -> Ptr b -> CSize -> IO LaSSize

type ArchiveOpenCallback a = Ptr Archive -> Ptr a -> IO ArchiveResult

type ArchiveCloseCallback a = Ptr Archive -> Ptr a -> IO ArchiveResult

type ArchiveSwitchCallback a b = Ptr Archive -> Ptr a -> Ptr b -> IO ArchiveResult

type ArchiveOpenCallbackRaw a = Ptr Archive -> Ptr a -> IO CInt

type ArchiveCloseCallbackRaw a = Ptr Archive -> Ptr a -> IO CInt

type ArchiveSwitchCallbackRaw a b = Ptr Archive -> Ptr a -> Ptr b -> IO CInt

type ArchivePassphraseCallback a = Ptr Archive -> Ptr a -> IO CString

type ArchiveFreeCallback a = Ptr Archive -> Ptr a -> IO ArchiveResult

Callback constructors

noOpenCallback :: FunPtr (ArchiveOpenCallbackRaw a)

Don't use an open callback. This is the recommended argument to archiveReadOpen

mkReadCallback :: ArchiveReadCallback a b -> IO (FunPtr (ArchiveReadCallback a b))

mkSkipCallback :: ArchiveSkipCallback a -> IO (FunPtr (ArchiveSkipCallback a))

mkSeekCallback :: ArchiveSeekCallback a -> IO (FunPtr (ArchiveSeekCallback a))

mkWriteCallback :: ArchiveWriteCallback a b -> IO (FunPtr (ArchiveWriteCallback a b))

mkPassphraseCallback :: ArchivePassphraseCallback a -> IO (FunPtr (ArchivePassphraseCallback a))

mkOpenCallback :: ArchiveOpenCallback a -> IO (FunPtr (ArchiveOpenCallbackRaw a))

mkCloseCallback :: ArchiveCloseCallback a -> IO (FunPtr (ArchiveCloseCallbackRaw a))

mkSwitchCallback :: ArchiveSwitchCallback a b -> IO (FunPtr (ArchiveSwitchCallbackRaw a b))

mkFreeCallback :: ArchiveFreeCallback a -> IO (FunPtr (ArchiveFreeCallbackRaw a))

mkWriteLookup :: (Ptr a -> CString -> LaInt64 -> IO LaInt64) -> IO (FunPtr (Ptr a -> CString -> LaInt64 -> IO LaInt64))

mkReadLookup :: (Ptr a -> LaInt64 -> IO CString) -> IO (FunPtr (Ptr a -> LaInt64 -> IO CString))

Also for archiveReadDiskSetGnameLookup and archiveReadDiskSetUnameLookup

mkCleanup :: (Ptr a -> IO ()) -> IO (FunPtr (Ptr a -> IO ()))

Can also be used with archiveReadExtractSetProgressCallback

mkMatch :: (Ptr Archive -> Ptr a -> Ptr ArchiveEntry -> IO ()) -> IO (FunPtr (Ptr Archive -> Ptr a -> Ptr ArchiveEntry -> IO ()))

mkFilter :: (Ptr Archive -> Ptr a -> Ptr ArchiveEntry -> IO Bool) -> IO (FunPtr (Ptr Archive -> Ptr a -> Ptr ArchiveEntry -> IO CInt))

mkExcludedCallback :: (Ptr Archive -> Ptr a -> Ptr ArchiveEntry -> IO ()) -> IO (FunPtr (Ptr Archive -> Ptr a -> Ptr ArchiveEntry -> IO ()))

Type synonyms

type ArchiveEntryPtr = ForeignPtr ArchiveEntry

type ArchivePtr = ForeignPtr Archive

type StatPtr = Ptr Stat

libarchive types

type LaInt64 = CLong

type LaSSize = CLong