hackage-security-0.5.3.0: Hackage security library

Safe HaskellNone
LanguageHaskell2010

Hackage.Security.Util.Path

Contents

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

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

Defined in Hackage.Security.Util.JSON

Methods

fromObjectKey :: String -> m (Maybe (Path root)) Source #

Monad m => ToObjectKey m (Path root) Source # 
Instance details

Defined in Hackage.Security.Util.JSON

Methods

toObjectKey :: Path root -> m String Source #

Eq (Path a) Source # 
Instance details

Defined in Hackage.Security.Util.Path

Methods

(==) :: Path a -> Path a -> Bool

(/=) :: Path a -> Path a -> Bool

Ord (Path a) Source # 
Instance details

Defined in Hackage.Security.Util.Path

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

Defined in Hackage.Security.Util.Path

Methods

showsPrec :: Int -> Path a -> ShowS

show :: Path a -> String

showList :: [Path a] -> ShowS

Pretty (Path Tar) Source # 
Instance details

Defined in Hackage.Security.Util.Path

Methods

pretty :: Path Tar -> String Source #

Pretty (Path HomeDir) Source # 
Instance details

Defined in Hackage.Security.Util.Path

Methods

pretty :: Path HomeDir -> String Source #

Pretty (Path Absolute) Source # 
Instance details

Defined in Hackage.Security.Util.Path

Methods

pretty :: Path Absolute -> String Source #

Pretty (Path Relative) Source # 
Instance details

Defined in Hackage.Security.Util.Path

Methods

pretty :: Path Relative -> String Source #

Pretty (Path Unrooted) Source # 
Instance details

Defined in Hackage.Security.Util.Path

Methods

pretty :: Path Unrooted -> String Source #

Pretty (Path CacheRoot) Source # 
Instance details

Defined in Hackage.Security.TUF.Paths

Methods

pretty :: Path CacheRoot -> String Source #

Pretty (Path IndexRoot) Source # 
Instance details

Defined in Hackage.Security.TUF.Paths

Methods

pretty :: Path IndexRoot -> String Source #

Pretty (Path RepoRoot) Source # 
Instance details

Defined in Hackage.Security.TUF.Paths

Methods

pretty :: Path RepoRoot -> String Source #

castRoot :: Path root -> Path root' Source #

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

takeFileName :: Path a -> String Source #

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

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

takeExtension :: Path a -> String Source #

Unrooted paths

data Unrooted Source #

Type-level tag for unrooted paths

Unrooted paths need a root before they can be interpreted.

Instances
Pretty (Path Unrooted) Source # 
Instance details

Defined in Hackage.Security.Util.Path

Methods

pretty :: Path Unrooted -> String Source #

rootPath :: Path Unrooted -> Path root Source #

Reinterpret an unrooted path

This is an alias for castRoot; see comments there.

unrootPath :: Path root -> Path Unrooted Source #

Forget a path's root

This is an alias for castRoot; see comments there.

toUnrootedFilePath :: Path Unrooted -> FilePath Source #

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

See also toAbsoluteFilePath

fromUnrootedFilePath :: FilePath -> Path Unrooted Source #

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

fragment :: String -> Path Unrooted Source #

A path fragment (like a single directory or filename)

File-system paths

data Relative Source #

Instances
FsRoot Relative Source # 
Instance details

Defined in Hackage.Security.Util.Path

Methods

toAbsoluteFilePath :: Path Relative -> IO FilePath Source #

Pretty (Path Relative) Source # 
Instance details

Defined in Hackage.Security.Util.Path

Methods

pretty :: Path Relative -> String Source #

data Absolute Source #

Instances
FsRoot Absolute Source # 
Instance details

Defined in Hackage.Security.Util.Path

Methods

toAbsoluteFilePath :: Path Absolute -> IO FilePath Source #

Pretty (Path Absolute) Source # 
Instance details

Defined in Hackage.Security.Util.Path

Methods

pretty :: Path Absolute -> String Source #

data HomeDir Source #

Instances
FsRoot HomeDir Source # 
Instance details

Defined in Hackage.Security.Util.Path

Methods

toAbsoluteFilePath :: Path HomeDir -> IO FilePath Source #

Pretty (Path HomeDir) Source # 
Instance details

Defined in Hackage.Security.Util.Path

Methods

pretty :: Path HomeDir -> String Source #

class FsRoot root where Source #

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

Methods

toAbsoluteFilePath :: Path root -> IO FilePath Source #

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

Instances
FsRoot HomeDir Source # 
Instance details

Defined in Hackage.Security.Util.Path

Methods

toAbsoluteFilePath :: Path HomeDir -> IO FilePath Source #

FsRoot Absolute Source # 
Instance details

Defined in Hackage.Security.Util.Path

Methods

toAbsoluteFilePath :: Path Absolute -> IO FilePath Source #

FsRoot Relative Source # 
Instance details

Defined in Hackage.Security.Util.Path

Methods

toAbsoluteFilePath :: Path Relative -> IO FilePath Source #

data FsPath Source #

Abstract over a file system root

see fromFilePath

Constructors

FsRoot root => FsPath (Path root) 

Conversions

fromFilePath :: FilePath -> FsPath Source #

Wrappers around System.IO

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

Wrapper around withFile

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

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

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

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

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

Wrappers around System.Directory

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

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

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

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

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

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

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

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

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

Return the immediate children of a directory

Filters out "." and "..".

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

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

Arguments

:: (FsRoot root, FsRoot root') 
=> Path root

Old

-> Path root'

New

-> IO () 

Wrappers around Codec.Archive.Tar

data Tar Source #

Instances
Pretty (Path Tar) Source # 
Instance details

Defined in Hackage.Security.Util.Path

Methods

pretty :: Path Tar -> String Source #

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

tarAppend Source #

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

toURIPath :: FilePath -> Path Web Source #

fromURIPath :: Path Web -> FilePath Source #

uriPath :: URI -> Path Web Source #

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

Re-exports

data IOMode #

Instances
Enum IOMode 
Instance details

Defined in GHC.IO.IOMode

Eq IOMode 
Instance details

Defined in GHC.IO.IOMode

Methods

(==) :: IOMode -> IOMode -> Bool

(/=) :: IOMode -> IOMode -> Bool

Ord IOMode 
Instance details

Defined in GHC.IO.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 
Instance details

Defined in GHC.IO.IOMode

Methods

readsPrec :: Int -> ReadS IOMode

readList :: ReadS [IOMode]

readPrec :: ReadPrec IOMode

readListPrec :: ReadPrec [IOMode]

Show IOMode 
Instance details

Defined in GHC.IO.IOMode

Methods

showsPrec :: Int -> IOMode -> ShowS

show :: IOMode -> String

showList :: [IOMode] -> ShowS

Ix IOMode 
Instance details

Defined in GHC.IO.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 
Instance details

Defined in GHC.IO.Handle.Types

Methods

(==) :: BufferMode -> BufferMode -> Bool

(/=) :: BufferMode -> BufferMode -> Bool

Ord BufferMode 
Instance details

Defined in GHC.IO.Handle.Types

Read BufferMode 
Instance details

Defined in GHC.IO.Handle.Types

Methods

readsPrec :: Int -> ReadS BufferMode

readList :: ReadS [BufferMode]

readPrec :: ReadPrec BufferMode

readListPrec :: ReadPrec [BufferMode]

Show BufferMode 
Instance details

Defined in GHC.IO.Handle.Types

Methods

showsPrec :: Int -> BufferMode -> ShowS

show :: BufferMode -> String

showList :: [BufferMode] -> ShowS

data Handle #

Instances
Eq Handle 
Instance details

Defined in GHC.IO.Handle.Types

Methods

(==) :: Handle -> Handle -> Bool

(/=) :: Handle -> Handle -> Bool

Show Handle 
Instance details

Defined in GHC.IO.Handle.Types

Methods

showsPrec :: Int -> Handle -> ShowS

show :: Handle -> String

showList :: [Handle] -> ShowS

data SeekMode #

Instances
Enum SeekMode 
Instance details

Defined in GHC.IO.Device

Eq SeekMode 
Instance details

Defined in GHC.IO.Device

Methods

(==) :: SeekMode -> SeekMode -> Bool

(/=) :: SeekMode -> SeekMode -> Bool

Ord SeekMode 
Instance details

Defined in GHC.IO.Device

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 
Instance details

Defined in GHC.IO.Device

Methods

readsPrec :: Int -> ReadS SeekMode

readList :: ReadS [SeekMode]

readPrec :: ReadPrec SeekMode

readListPrec :: ReadPrec [SeekMode]

Show SeekMode 
Instance details

Defined in GHC.IO.Device

Methods

showsPrec :: Int -> SeekMode -> ShowS

show :: SeekMode -> String

showList :: [SeekMode] -> ShowS

Ix SeekMode 
Instance details

Defined in GHC.IO.Device

hClose :: Handle -> IO () #

hFileSize :: Handle -> IO Integer #

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