Safe Haskell	None
Language	Haskell2010

Hackage.Security.Util.Path

Contents

Paths
FilePath-like operations on paths with arbitrary roots
Unrooted paths
File-system paths
Wrappers around Codec.Archive.Tar
Wrappers around Network.URI
Re-exports

Description

A more type-safe version of file paths

This module is intended to replace imports of System.FilePath, and additionally exports thin wrappers around common IO functions. To facilitate importing this module unqualified we also re-export some definitions from System.IO (importing both would likely lead to name clashes).

Note that his module does not import any other modules from Hackage.Security; everywhere else we use Path instead of FilePath directly.

Synopsis

Paths

newtype Path a #

Paths

A Path is simply a FilePath with a type-level tag indicating where this path is rooted (relative to the current directory, absolute path, relative to a web domain, whatever). Most operations on Path are just lifted versions of the operations on the underlying FilePath. The tag however allows us to give a lot of operations a more meaningful type. For instance, it does not make sense to append two absolute paths together; instead, we can only append an unrooted path to another path. It also means we avoid bugs where we use one kind of path where we expect another.

Constructors

Path FilePath

Instances

Monad m => FromObjectKey m (Path root) #
Methods fromObjectKey :: String -> m (Maybe (Path root)) #
Monad m => ToObjectKey m (Path root) #
Methods toObjectKey :: Path root -> m String #
Eq (Path a) #
Methods (==) :: Path a -> Path a -> Bool (/=) :: Path a -> Path a -> Bool
Ord (Path a) #
Methods compare :: Path a -> Path a -> Ordering (<) :: Path a -> Path a -> Bool (<=) :: Path a -> Path a -> Bool (>) :: Path a -> Path a -> Bool (>=) :: Path a -> Path a -> Bool max :: Path a -> Path a -> Path a min :: Path a -> Path a -> Path a
Show (Path a) #
Methods showsPrec :: Int -> Path a -> ShowS show :: Path a -> String showList :: [Path a] -> ShowS
Pretty (Path Tar) #
Methods pretty :: Path Tar -> String #
Pretty (Path HomeDir) #
Methods pretty :: Path HomeDir -> String #
Pretty (Path Absolute) #
Methods pretty :: Path Absolute -> String #
Pretty (Path Relative) #
Methods pretty :: Path Relative -> String #
Pretty (Path Unrooted) #
Methods pretty :: Path Unrooted -> String #
Pretty (Path CacheRoot) #
Methods pretty :: Path CacheRoot -> String #
Pretty (Path IndexRoot) #
Methods pretty :: Path IndexRoot -> String #
Pretty (Path RepoRoot) #
Methods pretty :: Path RepoRoot -> String #

castRoot :: Path root -> Path root' #

Reinterpret the root of a path

This literally just changes the type-level tag; use with caution!

FilePath-like operations on paths with arbitrary roots

takeDirectory :: Path a -> Path a #

takeFileName :: Path a -> String #

(<.>) :: Path a -> String -> Path a #

splitExtension :: Path a -> (Path a, String) #

takeExtension :: Path a -> String #

Unrooted paths

data Unrooted #

Type-level tag for unrooted paths

Unrooted paths need a root before they can be interpreted.

Instances

Pretty (Path Unrooted) #
Methods pretty :: Path Unrooted -> String #

(</>) :: Path a -> Path Unrooted -> Path a #

rootPath :: Path Unrooted -> Path root #

Reinterpret an unrooted path

This is an alias for castRoot; see comments there.

unrootPath :: Path root -> Path Unrooted #

Forget a path's root

This is an alias for castRoot; see comments there.

toUnrootedFilePath :: Path Unrooted -> FilePath #

Convert a relative/unrooted Path to a FilePath (using POSIX style directory separators).

File-system paths

data Relative #

Instances

FsRoot Relative #
Methods toAbsoluteFilePath :: Path Relative -> IO FilePath #
Pretty (Path Relative) #
Methods pretty :: Path Relative -> String #

data Absolute #

Instances

FsRoot Absolute #
Methods toAbsoluteFilePath :: Path Absolute -> IO FilePath #
Pretty (Path Absolute) #
Methods pretty :: Path Absolute -> String #

data HomeDir #

Instances

FsRoot HomeDir #
Methods toAbsoluteFilePath :: Path HomeDir -> IO FilePath #
Pretty (Path HomeDir) #
Methods pretty :: Path HomeDir -> String #

class FsRoot root where #

A file system root can be interpreted as an (absolute) FilePath

Minimal complete definition

toAbsoluteFilePath

Methods

toAbsoluteFilePath :: Path root -> IO FilePath #

Convert a Path to an absolute FilePath (using native style directory separators).

Instances

FsRoot HomeDir #
Methods toAbsoluteFilePath :: Path HomeDir -> IO FilePath #
FsRoot Absolute #
Methods toAbsoluteFilePath :: Path Absolute -> IO FilePath #
FsRoot Relative #
Methods toAbsoluteFilePath :: Path Relative -> IO FilePath #

data FsPath #

Abstract over a file system root

see fromFilePath

Constructors

FsRoot root => FsPath (Path root)

Conversions

toFilePath :: Path Absolute -> FilePath #

fromFilePath :: FilePath -> FsPath #

makeAbsolute :: FsPath -> IO (Path Absolute) #

fromAbsoluteFilePath :: FilePath -> Path Absolute #

Wrappers around System.IO

withFile :: FsRoot root => Path root -> IOMode -> (Handle -> IO r) -> IO r #

Wrapper around withFile

openTempFile' :: FsRoot root => Path root -> String -> IO (Path Absolute, Handle) #

Wrapper around openBinaryTempFileWithDefaultPermissions

NOTE: The caller is responsible for cleaning up the temporary file.

Wrappers around Data.ByteString

readLazyByteString :: FsRoot root => Path root -> IO ByteString #

readStrictByteString :: FsRoot root => Path root -> IO ByteString #

writeLazyByteString :: FsRoot root => Path root -> ByteString -> IO () #

writeStrictByteString :: FsRoot root => Path root -> ByteString -> IO () #

Wrappers around System.Directory

copyFile :: (FsRoot root, FsRoot root') => Path root -> Path root' -> IO () #

createDirectory :: FsRoot root => Path root -> IO () #

createDirectoryIfMissing :: FsRoot root => Bool -> Path root -> IO () #

removeDirectory :: FsRoot root => Path root -> IO () #

doesFileExist :: FsRoot root => Path root -> IO Bool #

doesDirectoryExist :: FsRoot root => Path root -> IO Bool #

getModificationTime :: FsRoot root => Path root -> IO UTCTime #

removeFile :: FsRoot root => Path root -> IO () #

getTemporaryDirectory :: IO (Path Absolute) #

getDirectoryContents :: FsRoot root => Path root -> IO [Path Unrooted] #

Return the immediate children of a directory

Filters out "." and "..".

getRecursiveContents :: FsRoot root => Path root -> IO [Path Unrooted] #

Recursive traverse a directory structure

Returns a set of paths relative to the directory specified. The list is lazily constructed, so that directories are only read when required. (This is also essential to ensure that this function does not build the entire result in memory before returning, potentially running out of heap.)

renameFile #

Arguments

:: (FsRoot root, FsRoot root')
=> Path root	Old
-> Path root'	New
-> IO ()

getCurrentDirectory :: IO (Path Absolute) #

Wrappers around Codec.Archive.Tar

data Tar #

Instances

Pretty (Path Tar) #
Methods pretty :: Path Tar -> String #

tarIndexLookup :: TarIndex -> Path Tar -> Maybe TarIndexEntry #

tarAppend #

Arguments

:: (FsRoot root, FsRoot root')
=> Path root	Path of the `.tar` file
-> Path root'	Base directory
-> [Path Tar]	Files to add, relative to the base dir
-> IO ()

Wrappers around Network.URI

data Web #

toURIPath :: FilePath -> Path Web #

fromURIPath :: Path Web -> FilePath #

uriPath :: URI -> Path Web #

modifyUriPath :: URI -> (Path Web -> Path Web) -> URI #

Re-exports

data IOMode :: * #

Constructors

ReadMode
WriteMode
AppendMode
ReadWriteMode

Instances

Enum IOMode
Methods succ :: IOMode -> IOMode pred :: IOMode -> IOMode toEnum :: Int -> IOMode fromEnum :: IOMode -> Int enumFrom :: IOMode -> [IOMode] enumFromThen :: IOMode -> IOMode -> [IOMode] enumFromTo :: IOMode -> IOMode -> [IOMode] enumFromThenTo :: IOMode -> IOMode -> IOMode -> [IOMode]
Eq IOMode
Methods (==) :: IOMode -> IOMode -> Bool (/=) :: IOMode -> IOMode -> Bool
Ord IOMode
Methods compare :: IOMode -> IOMode -> Ordering (<) :: IOMode -> IOMode -> Bool (<=) :: IOMode -> IOMode -> Bool (>) :: IOMode -> IOMode -> Bool (>=) :: IOMode -> IOMode -> Bool max :: IOMode -> IOMode -> IOMode min :: IOMode -> IOMode -> IOMode
Read IOMode
Methods readsPrec :: Int -> ReadS IOMode readList :: ReadS [IOMode] readPrec :: ReadPrec IOMode readListPrec :: ReadPrec [IOMode]
Show IOMode
Methods showsPrec :: Int -> IOMode -> ShowS show :: IOMode -> String showList :: [IOMode] -> ShowS
Ix IOMode
Methods range :: (IOMode, IOMode) -> [IOMode] index :: (IOMode, IOMode) -> IOMode -> Int unsafeIndex :: (IOMode, IOMode) -> IOMode -> Int inRange :: (IOMode, IOMode) -> IOMode -> Bool rangeSize :: (IOMode, IOMode) -> Int unsafeRangeSize :: (IOMode, IOMode) -> Int

data BufferMode :: * #

Constructors

NoBuffering
LineBuffering
BlockBuffering (Maybe Int)

Instances

Eq BufferMode
Methods (==) :: BufferMode -> BufferMode -> Bool (/=) :: BufferMode -> BufferMode -> Bool
Ord BufferMode
Methods compare :: BufferMode -> BufferMode -> Ordering (<) :: BufferMode -> BufferMode -> Bool (<=) :: BufferMode -> BufferMode -> Bool (>) :: BufferMode -> BufferMode -> Bool (>=) :: BufferMode -> BufferMode -> Bool max :: BufferMode -> BufferMode -> BufferMode min :: BufferMode -> BufferMode -> BufferMode
Read BufferMode
Methods readsPrec :: Int -> ReadS BufferMode readList :: ReadS [BufferMode] readPrec :: ReadPrec BufferMode readListPrec :: ReadPrec [BufferMode]
Show BufferMode
Methods showsPrec :: Int -> BufferMode -> ShowS show :: BufferMode -> String showList :: [BufferMode] -> ShowS

data Handle :: * #

Instances

Eq Handle
Methods (==) :: Handle -> Handle -> Bool (/=) :: Handle -> Handle -> Bool
Show Handle
Methods showsPrec :: Int -> Handle -> ShowS show :: Handle -> String showList :: [Handle] -> ShowS

data SeekMode :: * #

Constructors

AbsoluteSeek
RelativeSeek
SeekFromEnd

Instances

Enum SeekMode
Methods succ :: SeekMode -> SeekMode pred :: SeekMode -> SeekMode toEnum :: Int -> SeekMode fromEnum :: SeekMode -> Int enumFrom :: SeekMode -> [SeekMode] enumFromThen :: SeekMode -> SeekMode -> [SeekMode] enumFromTo :: SeekMode -> SeekMode -> [SeekMode] enumFromThenTo :: SeekMode -> SeekMode -> SeekMode -> [SeekMode]
Eq SeekMode
Methods (==) :: SeekMode -> SeekMode -> Bool (/=) :: SeekMode -> SeekMode -> Bool
Ord SeekMode
Methods compare :: SeekMode -> SeekMode -> Ordering (<) :: SeekMode -> SeekMode -> Bool (<=) :: SeekMode -> SeekMode -> Bool (>) :: SeekMode -> SeekMode -> Bool (>=) :: SeekMode -> SeekMode -> Bool max :: SeekMode -> SeekMode -> SeekMode min :: SeekMode -> SeekMode -> SeekMode
Read SeekMode
Methods readsPrec :: Int -> ReadS SeekMode readList :: ReadS [SeekMode] readPrec :: ReadPrec SeekMode readListPrec :: ReadPrec [SeekMode]
Show SeekMode
Methods showsPrec :: Int -> SeekMode -> ShowS show :: SeekMode -> String showList :: [SeekMode] -> ShowS
Ix SeekMode
Methods range :: (SeekMode, SeekMode) -> [SeekMode] index :: (SeekMode, SeekMode) -> SeekMode -> Int unsafeIndex :: (SeekMode, SeekMode) -> SeekMode -> Int inRange :: (SeekMode, SeekMode) -> SeekMode -> Bool rangeSize :: (SeekMode, SeekMode) -> Int unsafeRangeSize :: (SeekMode, SeekMode) -> Int

hSetBuffering :: Handle -> BufferMode -> IO () #

hClose :: Handle -> IO () #

hFileSize :: Handle -> IO Integer #

hSeek :: Handle -> SeekMode -> Integer -> IO () #