Codec.Archive.SAPCAR

(De-)compress SAPCAR files

Copyright (C) 2016, Virtual Forge GmbH

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

Documentation

type SapCar m a = StateT SapCarFile m a

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

data CarEntry

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

Methods

showsPrec :: Int -> CarEntry -> ShowS

show :: CarEntry -> String

showList :: [CarEntry] -> 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 -> Text

Get the filename of a car entry

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

Run all actions in the SapCar monad.

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

Run all actions in the SapCar monad.

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

Run all actions in the SapCar monad.

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

Get all entries contained inside the SapCar file.

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

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

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

Write a SapCar entry to the specified file.

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

Write a SapCar entry to the specified handle.