Generic.hs

module Archive.Generic ( packFromDir
                       , unpackFileToDir
                       , unpackFromFile
                       , packToFile
                       , archiveSigVersion
                       , packFromFiles
                       , unpackToDir
                       , packFiles
                       ) where

import           Archive
import           Archive.Compression
import           Control.Composition  ((.@))
import           Control.Exception    (throw)
import qualified Data.ByteString.Lazy as BSL
import qualified Data.Version         as V
import qualified Paths_archive_sig    as P


-- | @since 0.2.3.0
archiveSigVersion :: V.Version
archiveSigVersion = P.version

packFromFiles :: FilePath -- ^ Path of @.tar@ file to write
              -> [FilePath] -- ^ Files and directories to archive
              -> IO ()
packFromFiles = packFromFilesAndCompress id

packToFile :: FilePath -> [Entry] -> IO ()
packToFile = writeArchiveBytes .@ BSL.writeFile

unpackFromFile :: FilePath -> IO [Entry]
unpackFromFile = fmap (either throw id . readArchiveBytes) . BSL.readFile

unpackFileToDir :: FilePath -- ^ Filepath pointing to archive
                -> FilePath -- ^ Directory
                -> IO ()
unpackFileToDir = unpackFileToDirAndDecompress id

packFromDir :: FilePath -- ^ Directory to be packed up
            -> FilePath -- ^ @.tar@ archive file
            -> IO ()
packFromDir = packFromDirAndCompress id