hascar-0.2.2.1: Decompress SAPCAR archives

Copyright(C) 2015-2018 Virtual Forge GmbH
LicenseGPL2
MaintainerHans-Christian Esperer <hc@hcesperer.org>
Stabilityexperimental
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Codec.Archive.SAPCAR

Description

| (De-)compress SAPCAR files

Synopsis

Documentation

data SapCar s m a Source #

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

Instances

Monad m => Monad (SapCar s m) Source # 

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) Source # 

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) Source # 

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) Source # 

Methods

liftIO :: IO a -> SapCar s m a #

MonadThrow m => MonadThrow (SapCar s m) Source # 

Methods

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

MonadCatch m => MonadCatch (SapCar s m) Source # 

Methods

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

MonadMask m => MonadMask (SapCar s m) Source # 

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 Source #

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

Constructors

CarEntry 

Fields

Instances

data CarFileType Source #

The type of an entry in the SAPCAR file

Constructors

CarFile

A regular file

CarDirectory

A directory

CarUnknown

Something else

Instances

carEntryFilename :: CarEntry s -> Text Source #

Get the filename of a car entry

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

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 Source #

Run all actions in the SapCar monad.

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

Run all actions in the SapCar monad.

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

Get all entries contained inside the SapCar file.

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

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 () Source #

Write a SapCar entry to the specified file.

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

Write a SapCar entry to the specified handle.