Codec.Archive.FileCollection

A uniform interface over file archives and directories

Documentation

class File (AssocFile d) => FileCollection d where

class FileCollection d where An object that is a heirarchical arrangement | of files. This could be a tree in the file system, or a file archive.

Associated Types

type AssocFile d :: *

An element in the collection, capable of being read from.

Methods

createDirectory :: d -> FilePath -> IO d

createDirectory root path creates a new directory root/path which | is initially empty. The path to the new directory is returned.

createDirectoryIfMissing :: d -> FilePath -> IO d

createDirectoryIfMissing root path creates a new directory root/path | if it doesn't exist. It also creates any missing ancestors of path

removeDirectory :: d -> FilePath -> IO d

removeDirectory root dir removes an existing directory dir.

removeDirectoryRecursive :: d -> FilePath -> IO d

removeDirectoryRecursive root dir removes a directory dir and all | its contents and subdirectories.

renameDirectory :: d -> FilePath -> FilePath -> IO d

renameDirectory root source target changes the name of an existing | directory from source to target. If the target directory already | exists, it can be removed or merged with the source directory.

getDirectoryContents :: d -> FilePath -> IO [FilePath]

getDirectoryContents root dir returns a list of all entries | immediately contained in dir.

getFile :: d -> FilePath -> AssocFile d

getFile filePath returns a `AssocFile d` with the given path. | /Warning: Error checking is not guaranteed. This should only be used with | the output from getDirectoryContents

removeFile :: d -> FilePath -> IO d

removeFile root file removes the directory entry for an existing file, | where file is not a directory.

renameFile :: d -> FilePath -> FilePath -> IO d

renameFile root old new changes the name of an existing file from old | to new. If the new object already exists, it is replaced by old.

copyFile :: d -> FilePath -> FilePath -> IO d

copyFile root old new creates a duplicate of old with the name new.

addFile :: d -> AssocFile d -> IO d

addFile root file adds the file to the collection if it isn't already | present.

findFile :: d -> [FilePath] -> String -> IO (Maybe (AssocFile d))

findFile root dirs file returns the path of file if it can be found | in any of dirs.

findFiles :: d -> [FilePath] -> String -> IO [AssocFile d]

doesFileExist :: d -> FilePath -> IO Bool

doesFileExist root path returns True if path exists and is not a | directory.

doesDirectoryExist :: d -> FilePath -> IO Bool

doesDirectoryExist root path returns True if /path exists and is a | directory.

Instances

FileCollection Archive

FileCollection [Char]

class File f where

Methods

fileName :: f -> String

readFile :: f -> IO ByteString

writeFile :: f -> ByteString -> IO f

appendFile :: f -> ByteString -> IO f

Instances

File FilePath

File Entry