hackage-security-0.6.2.3: Hackage security library

Safe Haskell | Safe-Inferred
Language | Haskell2010

Hackage.Security.Util.Path

Contents

- Paths
- FilePath-like operations on paths with arbitrary roots
- Unrooted paths
- File-system paths
  - Conversions
  - Wrappers around System.IO
  - Wrappers around Data.ByteString
  - Wrappers around System.Directory
- 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

- newtype Path a = Path FilePath
- castRoot :: Path root -> Path root'
- takeDirectory :: Path a -> Path a
- takeFileName :: Path a -> String
- (<.>) :: Path a -> String -> Path a
- splitExtension :: Path a -> (Path a, String)
- takeExtension :: Path a -> String
- data Unrooted
- (</>) :: Path a -> Path Unrooted -> Path a
- rootPath :: Path Unrooted -> Path root
- unrootPath :: Path root -> Path Unrooted
- toUnrootedFilePath :: Path Unrooted -> FilePath
- fromUnrootedFilePath :: FilePath -> Path Unrooted
- fragment :: String -> Path Unrooted
- joinFragments :: [String] -> Path Unrooted
- splitFragments :: Path Unrooted -> [String]
- isPathPrefixOf :: Path Unrooted -> Path Unrooted -> Bool
- data Relative
- data Absolute
- data HomeDir
- class FsRoot root where
  - toAbsoluteFilePath :: Path root -> IO FilePath
- data FsPath = forall root.FsRoot root => FsPath (Path root)
- toFilePath :: Path Absolute -> FilePath
- fromFilePath :: FilePath -> FsPath
- makeAbsolute :: FsPath -> IO (Path Absolute)
- fromAbsoluteFilePath :: FilePath -> Path Absolute
- withFile :: FsRoot root => Path root -> IOMode -> (Handle -> IO r) -> IO r
- openTempFile' :: FsRoot root => Path root -> String -> IO (Path Absolute, Handle)
- 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 ()
- 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]
- getRecursiveContents :: FsRoot root => Path root -> IO [Path Unrooted]
- renameFile :: (FsRoot root, FsRoot root') => Path root -> Path root' -> IO ()
- getCurrentDirectory :: IO (Path Absolute)
- data Tar
- tarIndexLookup :: TarIndex -> Path Tar -> Maybe TarIndexEntry
- tarAppend :: (FsRoot root, FsRoot root') => Path root -> Path root' -> [Path Tar] -> IO ()
- data Web
- toURIPath :: FilePath -> Path Web
- fromURIPath :: Path Web -> FilePath
- uriPath :: URI -> Path Web
- modifyUriPath :: URI -> (Path Web -> Path Web) -> URI
- data IOMode
  - = ReadMode
  - | WriteMode
  - | AppendMode
  - | ReadWriteMode
- data BufferMode
  - = NoBuffering
  - | LineBuffering
  - | BlockBuffering (Maybe Int)
- data Handle
- data SeekMode
  - = AbsoluteSeek
  - | RelativeSeek
  - | SeekFromEnd
- hSetBuffering :: Handle -> BufferMode -> IO ()
- hClose :: Handle -> IO ()
- hFileSize :: Handle -> IO Integer
- hSeek :: Handle -> SeekMode -> Integer -> IO ()

# 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

Instances details

Monad m => FromObjectKey m (Path root) # |
Instance details Defined in Hackage.Security.Util.JSON Methods fromObjectKey :: String -> m (Maybe (Path root)) #
Monad m => ToObjectKey m (Path root) # |
Instance details Defined in Hackage.Security.Util.JSON Methods toObjectKey :: Path root -> m String #
Show (Path a) # |
Instance details Defined in Hackage.Security.Util.Path Methods showsPrec :: Int -> Path a -> ShowS show :: Path a -> String showList :: [Path a] -> ShowS
Eq (Path a) # |
Instance details Defined in Hackage.Security.Util.Path Methods (==) :: Path a -> Path a -> Bool (/=) :: Path a -> Path a -> Bool
Ord (Path a) # |
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
Pretty (Path CacheRoot) # |
Instance details Defined in Hackage.Security.TUF.Paths Methods pretty :: Path CacheRoot -> String #
Pretty (Path IndexRoot) # |
Instance details Defined in Hackage.Security.TUF.Paths Methods pretty :: Path IndexRoot -> String #
Pretty (Path RepoRoot) # |
Instance details Defined in Hackage.Security.TUF.Paths Methods pretty :: Path RepoRoot -> String #
Pretty (Path Absolute) # |
Instance details Defined in Hackage.Security.Util.Path Methods pretty :: Path Absolute -> String #
Pretty (Path HomeDir) # |
Instance details Defined in Hackage.Security.Util.Path Methods pretty :: Path HomeDir -> String #
Pretty (Path Relative) # |
Instance details Defined in Hackage.Security.Util.Path Methods pretty :: Path Relative -> String #
Pretty (Path Tar) # |
Instance details Defined in Hackage.Security.Util.Path Methods pretty :: Path Tar -> String #
Pretty (Path Unrooted) # |
Instance details Defined in Hackage.Security.Util.Path Methods pretty :: Path Unrooted -> 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

Instances details

Pretty (Path Unrooted) # |
Instance details Defined in Hackage.Security.Util.Path 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).

See also `toAbsoluteFilePath`

fromUnrootedFilePath :: FilePath -> Path Unrooted #

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

fragment :: String -> Path Unrooted #

A path fragment (like a single directory or filename)

joinFragments :: [String] -> Path Unrooted #

splitFragments :: Path Unrooted -> [String] #

isPathPrefixOf :: Path Unrooted -> Path Unrooted -> Bool #

# File-system paths

data Relative #

#### Instances

Instances details

FsRoot Relative # |
Instance details Defined in Hackage.Security.Util.Path Methods toAbsoluteFilePath :: Path Relative -> IO FilePath #
Pretty (Path Relative) # |
Instance details Defined in Hackage.Security.Util.Path Methods pretty :: Path Relative -> String #

data Absolute #

#### Instances

Instances details

FsRoot Absolute # |
Instance details Defined in Hackage.Security.Util.Path Methods toAbsoluteFilePath :: Path Absolute -> IO FilePath #
Pretty (Path Absolute) # |
Instance details Defined in Hackage.Security.Util.Path Methods pretty :: Path Absolute -> String #

data HomeDir #

#### Instances

Instances details

FsRoot HomeDir # |
Instance details Defined in Hackage.Security.Util.Path Methods toAbsoluteFilePath :: Path HomeDir -> IO FilePath #
Pretty (Path HomeDir) # |
Instance details Defined in Hackage.Security.Util.Path Methods pretty :: Path HomeDir -> String #

class FsRoot root where #

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

Methods

toAbsoluteFilePath :: Path root -> IO FilePath #

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

#### Instances

Instances details

FsRoot Absolute # |
Instance details Defined in Hackage.Security.Util.Path Methods toAbsoluteFilePath :: Path Absolute -> IO FilePath #
FsRoot HomeDir # |
Instance details Defined in Hackage.Security.Util.Path Methods toAbsoluteFilePath :: Path HomeDir -> IO FilePath #
FsRoot Relative # |
Instance details Defined in Hackage.Security.Util.Path Methods toAbsoluteFilePath :: Path Relative -> IO FilePath #

data FsPath #

Abstract over a file system root

see `fromFilePath`

Constructors

forall root.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

Instances details

Pretty (Path Tar) # |
Instance details Defined in Hackage.Security.Util.Path 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

Instances details

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

data BufferMode #

Constructors

NoBuffering |
LineBuffering |
BlockBuffering (Maybe Int) |

#### Instances

Instances details

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

data Handle #

#### Instances

Instances details

Show Handle |
Instance details Defined in GHC.IO.Handle.Types Methods showsPrec :: Int -> Handle -> ShowS show :: Handle -> String showList :: [Handle] -> ShowS
Eq Handle |
Instance details Defined in GHC.IO.Handle.Types Methods (==) :: Handle -> Handle -> Bool (/=) :: Handle -> Handle -> Bool

data SeekMode #

Constructors

AbsoluteSeek |
RelativeSeek |
SeekFromEnd |

#### Instances

Instances details

Enum SeekMode |
Instance details Defined in GHC.IO.Device 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]
Ix SeekMode |
Instance details Defined in GHC.IO.Device 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
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
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

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

hClose :: Handle -> IO () #

hFileSize :: Handle -> IO Integer #

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