Codec.Archive.SAPCAR

| (De-)compress SAPCAR files

Documentation

data SapCar s m a

The SAPCAR monad. All operations on SAPCAR files should happen inside this monad.

Instances

Monad m => Monad (SapCar s m)

Methods

(>>=) :: SapCar s m a -> (a -> SapCar s m b) -> SapCar s m b

(>>) :: SapCar s m a -> SapCar s m b -> SapCar s m b

return :: a -> SapCar s m a

fail :: String -> SapCar s m a

Functor m => Functor (SapCar s m)

Methods

fmap :: (a -> b) -> SapCar s m a -> SapCar s m b

(<$) :: a -> SapCar s m b -> SapCar s m a

Monad m => Applicative (SapCar s m)

Methods

pure :: a -> SapCar s m a

(<*>) :: SapCar s m (a -> b) -> SapCar s m a -> SapCar s m b

liftA2 :: (a -> b -> c) -> SapCar s m a -> SapCar s m b -> SapCar s m c

(*>) :: SapCar s m a -> SapCar s m b -> SapCar s m b

(<*) :: SapCar s m a -> SapCar s m b -> SapCar s m a

MonadIO m => MonadIO (SapCar s m)

Methods

liftIO :: IO a -> SapCar s m a

MonadThrow m => MonadThrow (SapCar s m)

Methods

throwM :: Exception e => e -> SapCar s m a

MonadCatch m => MonadCatch (SapCar s m)

Methods

catch :: Exception e => SapCar s m a -> (e -> SapCar s m a) -> SapCar s m a

MonadMask m => MonadMask (SapCar s m)

Methods

mask :: ((forall a. SapCar s m a -> SapCar s m a) -> SapCar s m b) -> SapCar s m b

uninterruptibleMask :: ((forall a. SapCar s m a -> SapCar s m a) -> SapCar s m b) -> SapCar s m b

data CarEntry s

Meta information about a single file or directory in a SAPCAR archive

Constructors

CarEntry

Fields

• cfFileType :: !CarFileType

  The type of the entry

• cfPermissions :: !Word32

  The unix style permissions of the entry

• cfLength :: !Word32

  The uncompressed length of the whole file, if it is a file

• cfTimestamp :: !Word32

  The EPOCH timestamp of the file

• cfFileName :: !Text

  The filename

• cfFileOffset :: !Int64

  The absolute offset of the entry in the SAPCAR file

• cfPayloadOffset :: !Int64

  The absolute offset of the payload of the entry

Instances

Show (CarEntry s)

Methods

showsPrec :: Int -> CarEntry s -> ShowS

show :: CarEntry s -> String

showList :: [CarEntry s] -> ShowS

data CarFileType

The type of an entry in the SAPCAR file

Constructors

CarFile

A regular file

CarDirectory

A directory

CarUnknown

Something else

Instances

Enum CarFileType

Methods

succ :: CarFileType -> CarFileType

pred :: CarFileType -> CarFileType

toEnum :: Int -> CarFileType

fromEnum :: CarFileType -> Int

enumFrom :: CarFileType -> [CarFileType]

enumFromThen :: CarFileType -> CarFileType -> [CarFileType]

enumFromTo :: CarFileType -> CarFileType -> [CarFileType]

enumFromThenTo :: CarFileType -> CarFileType -> CarFileType -> [CarFileType]

Eq CarFileType

Methods

(==) :: CarFileType -> CarFileType -> Bool

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

Show CarFileType

Methods

showsPrec :: Int -> CarFileType -> ShowS

show :: CarFileType -> String

showList :: [CarFileType] -> ShowS

carEntryFilename :: CarEntry s -> Text

Get the filename of a car entry

withSapCarFile :: (MonadIO m, MonadThrow m, MonadMask m) => FilePath -> (forall s. SapCar s m a) -> m a

Run all actions in the SapCar monad.

withSapCarPath :: (MonadIO m, MonadThrow m, MonadMask m) => Path b File -> (forall s. SapCar s m a) -> m a

Run all actions in the SapCar monad.

withSapCarHandle :: (MonadIO m, MonadThrow m, MonadMask m) => (forall s. SapCar s m a) -> Handle -> m a

Run all actions in the SapCar monad.

getEntries :: MonadIO m => SapCar s m [CarEntry s]

Get all entries contained inside the SapCar file.

sourceEntry :: MonadIO m => CarEntry s -> Sink ByteString IO a -> SapCar s m a

Stream the contents of the given SapCar entry to the specified conduit sink.

writeToFile :: (MonadIO m, MonadMask m, MonadThrow m) => CarEntry s -> Path b File -> SapCar s m ()

Write a SapCar entry to the specified file.

writeToHandle :: (MonadIO m, MonadMask m, MonadThrow m) => CarEntry s -> Handle -> SapCar s m ()

Write a SapCar entry to the specified handle.