From c8d876842af691d79338dbae9f016371604081f1 Mon Sep 17 00:00:00 2001 From: travis-ci Date: Tue, 14 Jun 2016 17:39:20 +0000 Subject: [PATCH] Lastest docs updated travis build: 85 commit: 3baecb7b51fe2c5fb97ed0c8798556798032518c auto-pushed to gh-pages --- HPath-IO-Errors.html | 32 +- HPath-IO.html | 44 +- HPath.html | 26 +- System-Posix-Directory-Foreign.html | 8 +- System-Posix-Directory-Traversals.html | 10 +- System-Posix-FD.html | 8 +- System-Posix-FilePath.html | 72 +-- doc-index-60.html | 4 +- doc-index-A.html | 4 +- doc-index-All.html | 4 +- doc-index-B.html | 4 +- doc-index-C.html | 4 +- doc-index-D.html | 4 +- doc-index-E.html | 4 +- doc-index-F.html | 4 +- doc-index-G.html | 4 +- doc-index-H.html | 4 +- doc-index-I.html | 4 +- doc-index-J.html | 4 +- doc-index-M.html | 4 +- doc-index-N.html | 4 +- doc-index-O.html | 4 +- doc-index-P.html | 4 +- doc-index-R.html | 4 +- doc-index-S.html | 4 +- doc-index-T.html | 4 +- doc-index-U.html | 4 +- doc-index-W.html | 4 +- doc-index.html | 4 +- frames.html | 2 +- haddock-util.js | 24 +- hpath.haddock | Bin 117580 -> 116972 bytes index-frames.html | 2 +- index.html | 4 +- mini_HPath-IO-Errors.html | 2 +- mini_HPath-IO.html | 2 +- mini_HPath.html | 2 +- mini_System-Posix-Directory-Foreign.html | 2 +- mini_System-Posix-Directory-Traversals.html | 2 +- mini_System-Posix-FD.html | 2 +- mini_System-Posix-FilePath.html | 2 +- ocean.css | 64 +- src/HPath-IO-Errors.html | 623 ++++++++++---------- 43 files changed, 506 insertions(+), 515 deletions(-) diff --git a/HPath-IO-Errors.html b/HPath-IO-Errors.html index f74a19a..bd96dcd 100644 --- a/HPath-IO-Errors.html +++ b/HPath-IO-Errors.html @@ -1,25 +1,25 @@ -HPath.IO.Errors

hpath-0.8.0: Support for well-typed paths

Copyright© 2016 Julian Ospald
LicenseBSD3
MaintainerJulian Ospald <hasufell@posteo.de>
Stabilityexperimental
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

HPath.IO.Errors

Description

Provides error handling.

Types

data HPathIOException Source #

Additional generic IO exceptions that the posix functions - do not provide.

Constructors

SameFile ByteString ByteString 
DestinationInSource ByteString ByteString 
RecursiveFailure [(RecursiveFailureHint, IOException)] 

Instances

data RecursiveFailureHint Source #

A type for giving failure hints on recursive failure, which allows +

hpath-0.8.0: Support for well-typed paths

Copyright© 2016 Julian Ospald
LicenseBSD3
MaintainerJulian Ospald <hasufell@posteo.de>
Stabilityexperimental
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

HPath.IO.Errors

Description

Provides error handling.

Types

data HPathIOException Source

Additional generic IO exceptions that the posix functions + do not provide.

Constructors

SameFile ByteString ByteString 
DestinationInSource ByteString ByteString 
RecursiveFailure [(RecursiveFailureHint, IOException)] 

Instances

data RecursiveFailureHint Source

A type for giving failure hints on recursive failure, which allows to programmatically make choices without examining the weakly typed I/O error attributes (like ioeGetFileName).

The first argument to the data constructor is always the - source and the second the destination.

Constructors

ReadContentsFailed (Path Abs) (Path Abs) 
CreateDirFailed (Path Abs) (Path Abs) 
CopyFileFailed (Path Abs) (Path Abs) 
RecreateSymlinkFailed (Path Abs) (Path Abs) 

Instances

Exception identifiers

isSameFile :: HPathIOException -> Bool Source #

isDestinationInSource :: HPathIOException -> Bool Source #

isRecursiveFailure :: HPathIOException -> Bool Source #

isReadContentsFailed :: RecursiveFailureHint -> Bool Source #

isCreateDirFailed :: RecursiveFailureHint -> Bool Source #

isCopyFileFailed :: RecursiveFailureHint -> Bool Source #

isRecreateSymlinkFailed :: RecursiveFailureHint -> Bool Source #

Path based functions

throwFileDoesExist :: Path Abs -> IO () Source #

Throws AlreadyExists IOError if file exists.

throwDirDoesExist :: Path Abs -> IO () Source #

Throws AlreadyExists IOError if directory exists.

throwSameFile :: Path Abs -> Path Abs -> IO () Source #

Uses isSameFile and throws SameFile if it returns True.

sameFile :: Path Abs -> Path Abs -> IO Bool Source #

Check if the files are the same by examining device and file id. - This follows symbolic links.

throwDestinationInSource Source #

Arguments

:: Path Abs

source dir

-> Path Abs

full destination, dirname dest - must exist

-> IO () 

Checks whether the destination directory is contained + source and the second the destination.

Constructors

ReadContentsFailed (Path Abs) (Path Abs) 
CreateDirFailed (Path Abs) (Path Abs) 
CopyFileFailed (Path Abs) (Path Abs) 
RecreateSymlinkFailed (Path Abs) (Path Abs) 

Instances

Exception identifiers

isSameFile :: HPathIOException -> Bool Source

isDestinationInSource :: HPathIOException -> Bool Source

isRecursiveFailure :: HPathIOException -> Bool Source

isReadContentsFailed :: RecursiveFailureHint -> Bool Source

isCreateDirFailed :: RecursiveFailureHint -> Bool Source

isCopyFileFailed :: RecursiveFailureHint -> Bool Source

isRecreateSymlinkFailed :: RecursiveFailureHint -> Bool Source

Path based functions

throwFileDoesExist :: Path Abs -> IO () Source

Throws AlreadyExists IOError if file exists.

throwDirDoesExist :: Path Abs -> IO () Source

Throws AlreadyExists IOError if directory exists.

throwSameFile :: Path Abs -> Path Abs -> IO () Source

Uses isSameFile and throws SameFile if it returns True.

sameFile :: Path Abs -> Path Abs -> IO Bool Source

Check if the files are the same by examining device and file id. + This follows symbolic links.

throwDestinationInSource Source

Arguments

:: Path Abs

source dir

-> Path Abs

full destination, dirname dest + must exist

-> IO () 

Checks whether the destination directory is contained within the source directory by comparing the device+file ID of the source directory with all device+file IDs of the parent directories - of the destination.

doesFileExist :: Path Abs -> IO Bool Source #

Checks if the given file exists and is not a directory. - Does not follow symlinks.

doesDirectoryExist :: Path Abs -> IO Bool Source #

Checks if the given file exists and is a directory. - Does not follow symlinks.

isWritable :: Path Abs -> IO Bool Source #

Checks whether a file or folder is writable.

canOpenDirectory :: Path Abs -> IO Bool Source #

Checks whether the directory at the given path exists and can be - opened. This invokes openDirStream which follows symlinks.

Error handling functions

catchErrno Source #

Arguments

:: [Errno]

errno to catch

-> IO a

action to try, which can raise an IOException

-> IO a

action to carry out in case of an IOException and - if errno matches

-> IO a 

Carries out an action, then checks if there is an IOException and + of the destination.

doesFileExist :: Path Abs -> IO Bool Source

Checks if the given file exists and is not a directory. + Does not follow symlinks.

doesDirectoryExist :: Path Abs -> IO Bool Source

Checks if the given file exists and is a directory. + Does not follow symlinks.

isWritable :: Path Abs -> IO Bool Source

Checks whether a file or folder is writable.

canOpenDirectory :: Path Abs -> IO Bool Source

Checks whether the directory at the given path exists and can be + opened. This invokes openDirStream which follows symlinks.

Error handling functions

catchErrno Source

Arguments

:: [Errno]

errno to catch

-> IO a

action to try, which can raise an IOException

-> IO a

action to carry out in case of an IOException and + if errno matches

-> IO a 

Carries out an action, then checks if there is an IOException and a specific errno. If so, then it carries out another action, otherwise - it rethrows the error.

rethrowErrnoAs Source #

Arguments

:: Exception e 
=> [Errno]

errno to catch

-> e

rethrow as if errno matches

-> IO a

action to try

-> IO a 

Execute the given action and retrow IO exceptions as a new Exception + it rethrows the error.

rethrowErrnoAs Source

Arguments

:: Exception e 
=> [Errno]

errno to catch

-> e

rethrow as if errno matches

-> IO a

action to try

-> IO a 

Execute the given action and retrow IO exceptions as a new Exception that have the given errno. If errno does not match the exception is rethrown - as is.

handleIOError :: (IOError -> IO a) -> IO a -> IO a Source #

Like catchIOError, with arguments swapped.

bracketeer Source #

Arguments

:: IO a

computation to run first

-> (a -> IO b)

computation to run last, when - no exception was raised

-> (a -> IO b)

computation to run last, - when an exception was raised

-> (a -> IO c)

computation to run in-between

-> IO c 

Like bracket, but allows to have different clean-up + as is.

handleIOError :: (IOError -> IO a) -> IO a -> IO a Source

Like catchIOError, with arguments swapped.

bracketeer Source

Arguments

:: IO a

computation to run first

-> (a -> IO b)

computation to run last, when + no exception was raised

-> (a -> IO b)

computation to run last, + when an exception was raised

-> (a -> IO c)

computation to run in-between

-> IO c 

Like bracket, but allows to have different clean-up actions depending on whether the in-between computation - has raised an exception or not.

reactOnError Source #

Arguments

:: IO a 
-> [(IOErrorType, IO a)]

reaction on IO errors

-> [(HPathIOException, IO a)]

reaction on HPathIOException

-> IO a 
\ No newline at end of file + has raised an exception or not.

reactOnError Source

Arguments

:: IO a 
-> [(IOErrorType, IO a)]

reaction on IO errors

-> [(HPathIOException, IO a)]

reaction on HPathIOException

-> IO a 
\ No newline at end of file diff --git a/HPath-IO.html b/HPath-IO.html index 2588690..2d56bfb 100644 --- a/HPath-IO.html +++ b/HPath-IO.html @@ -1,4 +1,4 @@ -HPath.IO

hpath-0.8.0: Support for well-typed paths

Copyright© 2016 Julian Ospald
LicenseBSD3
MaintainerJulian Ospald <hasufell@posteo.de>
Stabilityexperimental
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

HPath.IO

Description

This module provides high-level IO related file operations like @@ -16,16 +16,16 @@ window.onload = function () {pageLoad();setSynopsis("mini_HPath-IO.html");}; exception handling is kept.

Note: BlockDevice, CharacterDevice, NamedPipe and Socket are ignored by some of the more high-level functions (like easyCopy). For other functions (like copyFile), the behavior on these file types is - unreliable/unsafe. Check the documentation of those functions for details.

Types

data FileType Source #

Constructors

Directory 
RegularFile 
SymbolicLink 
BlockDevice 
CharacterDevice 
NamedPipe 
Socket 

Instances

data RecursiveErrorMode Source #

The error mode for recursive operations.

On FailEarly the whole operation fails immediately if any of the + unreliable/unsafe. Check the documentation of those functions for details.

Types

data FileType Source

Constructors

Directory 
RegularFile 
SymbolicLink 
BlockDevice 
CharacterDevice 
NamedPipe 
Socket 

Instances

data RecursiveErrorMode Source

The error mode for recursive operations.

On FailEarly the whole operation fails immediately if any of the recursive sub-operations fail, which is sort of the default for IO operations.

On CollectFailures skips errors in the recursion and keeps on recursing. However all errors are collected in the RecursiveFailure error type, which is raised finally if there was any error. Also note that RecursiveFailure does not give any guarantees on the ordering - of the collected exceptions.

Constructors

FailEarly 
CollectFailures 

data CopyMode Source #

The mode for copy and file moves. + of the collected exceptions.

Constructors

FailEarly 
CollectFailures 

data CopyMode Source

The mode for copy and file moves. Overwrite mode is usually not very well defined, but is a convenience - shortcut.

Constructors

Strict

fail if any target exists

Overwrite

overwrite targets

File copying

copyDirRecursive Source #

Arguments

:: Path Abs

source dir

-> Path Abs

destination (parent dirs - are not automatically created)

-> CopyMode 
-> RecursiveErrorMode 
-> IO () 

Copies the contents of a directory recursively to the given destination, while preserving permissions. + shortcut.

Constructors

Strict

fail if any target exists

Overwrite

overwrite targets

File copying

copyDirRecursive Source

Arguments

:: Path Abs

source dir

-> Path Abs

destination (parent dirs + are not automatically created)

-> CopyMode 
-> RecursiveErrorMode 
-> IO () 

Copies the contents of a directory recursively to the given destination, while preserving permissions. Does not follow symbolic links. This behaves more or less like the following, without descending into the destination if it already exists:

  cp -a /source/dir /destination/somedir
@@ -39,8 +39,8 @@ window.onload = function () {pageLoad();setSynopsis("mini_HPath-IO.html");};
       carried out recursively (because it's slow)
Throws:
Throws in FailEarly RecursiveErrorMode only:
  • PermissionDenied if output directory is not writable
  • InvalidArgument if source directory is wrong type (symlink)
  • InappropriateType if source directory is wrong type (regular file)
Throws in CollectFailures RecursiveErrorMode only:
Throws in Strict CopyMode only:
  • AlreadyExists if destination already exists

recreateSymlink Source #

Arguments

:: Path Abs

the old symlink file

-> Path Abs

destination file

-> CopyMode 
-> IO () 

Recreate a symlink.

In Overwrite copy mode only files and empty directories are deleted.

Safety/reliability concerns:

Throws:

  • InvalidArgument if source file is wrong type (not a symlink)
  • PermissionDenied if output directory cannot be written to
  • PermissionDenied if source directory cannot be opened
  • SameFile if source and destination are the same file - (HPathIOException)

Throws in Strict mode only:

  • AlreadyExists if destination already exists

Throws in Overwrite mode only:

  • UnsatisfiedConstraints if destination file is non-empty directory

Note: calls symlink

copyFile Source #

Arguments

:: Path Abs

source file

-> Path Abs

destination file

-> CopyMode 
-> IO () 

Copies the given regular file to the given destination. + part of the top-directory sanity-checks fail (HPathIOException)

Throws in Strict CopyMode only:

  • AlreadyExists if destination already exists

recreateSymlink Source

Arguments

:: Path Abs

the old symlink file

-> Path Abs

destination file

-> CopyMode 
-> IO () 

Recreate a symlink.

In Overwrite copy mode only files and empty directories are deleted.

Safety/reliability concerns:

Throws:

  • InvalidArgument if source file is wrong type (not a symlink)
  • PermissionDenied if output directory cannot be written to
  • PermissionDenied if source directory cannot be opened
  • SameFile if source and destination are the same file + (HPathIOException)

Throws in Strict mode only:

  • AlreadyExists if destination already exists

Throws in Overwrite mode only:

  • UnsatisfiedConstraints if destination file is non-empty directory

Note: calls symlink

copyFile Source

Arguments

:: Path Abs

source file

-> Path Abs

destination file

-> CopyMode 
-> IO () 

Copies the given regular file to the given destination. Neither follows symbolic links, nor accepts them. For "copying" symbolic links, use recreateSymlink instead.

Note that this is still sort of a low-level function and doesn't examine file types. For a more high-level version, use easyCopy @@ -48,34 +48,34 @@ window.onload = function () {pageLoad();setSynopsis("mini_HPath-IO.html");}; them to a regular file, which might take indefinitely

  • when used on BlockDevice, may either read the "contents" and copy them to a regular file (potentially hanging indefinitely) or may create a regular empty destination file
  • when used on NamedPipe, will hang indefinitely

    • Throws:

    • NoSuchThing if source file does not exist
    • NoSuchThing if source file is a a Socket
    • PermissionDenied if output directory is not writable
    • PermissionDenied if source directory can't be opened
    • InvalidArgument if source file is wrong type (symlink or directory)
    • SameFile if source and destination are the same file - (HPathIOException)

    Throws in Strict mode only:

    • AlreadyExists if destination already exists

    Note: calls sendfile and possibly read/write as fallback

    easyCopy :: Path Abs -> Path Abs -> CopyMode -> RecursiveErrorMode -> IO () Source #

    Copies a regular file, directory or symbolic link. In case of a + (HPathIOException)

    Throws in Strict mode only:

    • AlreadyExists if destination already exists

    Note: calls sendfile and possibly read/write as fallback

    easyCopy :: Path Abs -> Path Abs -> CopyMode -> RecursiveErrorMode -> IO () Source

    Copies a regular file, directory or symbolic link. In case of a symbolic link it is just recreated, even if it points to a directory. - Any other file type is ignored.

    Safety/reliability concerns:

    File deletion

    deleteFile :: Path Abs -> IO () Source #

    Deletes the given file. Raises eISDIR - if run on a directory. Does not follow symbolic links.

    Throws:

    • InappropriateType for wrong file type (directory)
    • NoSuchThing if the file does not exist
    • PermissionDenied if the directory cannot be read

    deleteDir :: Path Abs -> IO () Source #

    Deletes the given directory, which must be empty, never symlinks.

    Throws:

    • InappropriateType for wrong file type (symlink to directory)
    • InappropriateType for wrong file type (regular file)
    • NoSuchThing if directory does not exist
    • UnsatisfiedConstraints if directory is not empty
    • PermissionDenied if we can't open or write to parent directory

    Notes: calls rmdir

    deleteDirRecursive :: Path Abs -> IO () Source #

    Deletes the given directory recursively. Does not follow symbolic + Any other file type is ignored.

    Safety/reliability concerns:

    File deletion

    deleteFile :: Path Abs -> IO () Source

    Deletes the given file. Raises eISDIR + if run on a directory. Does not follow symbolic links.

    Throws:

    • InappropriateType for wrong file type (directory)
    • NoSuchThing if the file does not exist
    • PermissionDenied if the directory cannot be read

    deleteDir :: Path Abs -> IO () Source

    Deletes the given directory, which must be empty, never symlinks.

    Throws:

    • InappropriateType for wrong file type (symlink to directory)
    • InappropriateType for wrong file type (regular file)
    • NoSuchThing if directory does not exist
    • UnsatisfiedConstraints if directory is not empty
    • PermissionDenied if we can't open or write to parent directory

    Notes: calls rmdir

    deleteDirRecursive :: Path Abs -> IO () Source

    Deletes the given directory recursively. Does not follow symbolic links. Tries deleteDir first before attemtping a recursive deletion.

    On directory contents this behaves like easyDelete and thus will ignore any file type that is not RegularFile, - SymbolicLink or Directory.

    Safety/reliability concerns:

    • not atomic
    • examines filetypes explicitly

    Throws:

    • InappropriateType for wrong file type (symlink to directory)
    • InappropriateType for wrong file type (regular file)
    • NoSuchThing if directory does not exist
    • PermissionDenied if we can't open or write to parent directory

    easyDelete :: Path Abs -> IO () Source #

    Deletes a file, directory or symlink. + SymbolicLink or Directory.

    Safety/reliability concerns:

    • not atomic
    • examines filetypes explicitly

    Throws:

    • InappropriateType for wrong file type (symlink to directory)
    • InappropriateType for wrong file type (regular file)
    • NoSuchThing if directory does not exist
    • PermissionDenied if we can't open or write to parent directory

    easyDelete :: Path Abs -> IO () Source

    Deletes a file, directory or symlink. In case of directory, performs recursive deletion. In case of a symlink, the symlink file is deleted. - Any other file type is ignored.

    Safety/reliability concerns:

    File opening

    openFile :: Path Abs -> IO ProcessID Source #

    Opens a file appropriately by invoking xdg-open. The file type - is not checked. This forks a process.

    executeFile Source #

    Arguments

    :: Path Abs

    program

    -> [ByteString]

    arguments

    -> IO ProcessID 

    Executes a program with the given arguments. This forks a process.

    File creation

    createRegularFile :: FileMode -> Path Abs -> IO () Source #

    Create an empty regular file at the given directory with the given + Any other file type is ignored.

    Safety/reliability concerns:

    File opening

    openFile :: Path Abs -> IO ProcessID Source

    Opens a file appropriately by invoking xdg-open. The file type + is not checked. This forks a process.

    executeFile Source

    Arguments

    :: Path Abs

    program

    -> [ByteString]

    arguments

    -> IO ProcessID 

    Executes a program with the given arguments. This forks a process.

    File creation

    createRegularFile :: FileMode -> Path Abs -> IO () Source

    Create an empty regular file at the given directory with the given filename.

    Throws:

    • PermissionDenied if output directory cannot be written to
    • AlreadyExists if destination already exists
    • NoSuchThing if any of the parent components of the path - do not exist

    createDir :: FileMode -> Path Abs -> IO () Source #

    Create an empty directory at the given directory with the given filename.

    Throws:

    • PermissionDenied if output directory cannot be written to
    • AlreadyExists if destination already exists
    • NoSuchThing if any of the parent components of the path - do not exist

    createDirRecursive :: FileMode -> Path Abs -> IO () Source #

    Create an empty directory at the given directory with the given filename. + do not exist

    createDir :: FileMode -> Path Abs -> IO () Source

    Create an empty directory at the given directory with the given filename.

    Throws:

    • PermissionDenied if output directory cannot be written to
    • AlreadyExists if destination already exists
    • NoSuchThing if any of the parent components of the path + do not exist

    createDirRecursive :: FileMode -> Path Abs -> IO () Source

    Create an empty directory at the given directory with the given filename. All parent directories are created with the same filemode. This basically behaves like:

      mkdir -p /some/dir

    Safety/reliability concerns:

    • not atomic

    Throws:

    • PermissionDenied if any part of the path components do not exist and cannot be written to
    • AlreadyExists if destination already exists and - is not a directory

    createSymlink Source #

    Arguments

    :: Path Abs

    destination file

    -> ByteString

    path the symlink points to

    -> IO () 

    Create a symlink.

    Throws:

    • PermissionDenied if output directory cannot be written to
    • AlreadyExists if destination file already exists
    • NoSuchThing if any of the parent components of the path - do not exist

    Note: calls symlink

    File renaming/moving

    renameFile :: Path Abs -> Path Abs -> IO () Source #

    Rename a given file with the provided filename. Destination and source - must be on the same device, otherwise eXDEV will be raised.

    Does not follow symbolic links, but renames the symbolic link file.

    Safety/reliability concerns:

    • has a separate set of exception handling, apart from the syscall

    Throws:

    • NoSuchThing if source file does not exist
    • PermissionDenied if output directory cannot be written to
    • PermissionDenied if source directory cannot be opened
    • UnsupportedOperation if source and destination are on different + is not a directory

    createSymlink Source

    Arguments

    :: Path Abs

    destination file

    -> ByteString

    path the symlink points to

    -> IO () 

    Create a symlink.

    Throws:

    • PermissionDenied if output directory cannot be written to
    • AlreadyExists if destination file already exists
    • NoSuchThing if any of the parent components of the path + do not exist

    Note: calls symlink

    File renaming/moving

    renameFile :: Path Abs -> Path Abs -> IO () Source

    Rename a given file with the provided filename. Destination and source + must be on the same device, otherwise eXDEV will be raised.

    Does not follow symbolic links, but renames the symbolic link file.

    Safety/reliability concerns:

    • has a separate set of exception handling, apart from the syscall

    Throws:

    • NoSuchThing if source file does not exist
    • PermissionDenied if output directory cannot be written to
    • PermissionDenied if source directory cannot be opened
    • UnsupportedOperation if source and destination are on different devices
    • AlreadyExists if destination already exists
    • SameFile if destination and source are the same file - (HPathIOException)

    Note: calls rename (but does not allow to rename over existing files)

    moveFile Source #

    Arguments

    :: Path Abs

    file to move

    -> Path Abs

    destination

    -> CopyMode 
    -> IO () 

    Move a file. This also works across devices by copy-delete fallback. + (HPathIOException)

    Note: calls rename (but does not allow to rename over existing files)

    moveFile Source

    Arguments

    :: Path Abs

    file to move

    -> Path Abs

    destination

    -> CopyMode 
    -> IO () 

    Move a file. This also works across devices by copy-delete fallback. And also works on directories.

    Does not follow symbolic links, but renames the symbolic link file.

    Safety/reliability concerns:

    Throws:

    • NoSuchThing if source file does not exist
    • PermissionDenied if output directory cannot be written to
    • PermissionDenied if source directory cannot be opened
    • SameFile if destination and source are the same file - (HPathIOException)

    Throws in Strict mode only:

    • AlreadyExists if destination already exists

    Note: calls rename (but does not allow to rename over existing files)

    File permissions

    newFilePerms :: FileMode Source #

    Default permissions for a new file.

    newDirPerms :: FileMode Source #

    Default permissions for a new directory.

    Directory reading

    getDirsFiles Source #

    Arguments

    :: Path Abs

    dir to read

    -> IO [Path Abs] 

    Gets all filenames of the given directory. This excludes "." and "..". - This version does not follow symbolic links.

    The contents are not sorted and there is no guarantee on the ordering.

    Throws:

    • NoSuchThing if directory does not exist
    • InappropriateType if file type is wrong (file)
    • InappropriateType if file type is wrong (symlink to file)
    • InappropriateType if file type is wrong (symlink to dir)
    • PermissionDenied if directory cannot be opened

    Filetype operations

    getFileType :: Path Abs -> IO FileType Source #

    Get the file type of the file located at the given path. Does - not follow symbolic links.

    Throws:

    • NoSuchThing if the file does not exist
    • PermissionDenied if any part of the path is not accessible

    Others

    canonicalizePath :: Path Abs -> IO (Path Abs) Source #

    Applies realpath on the given absolute path.

    Throws:

    • NoSuchThing if the file at the given path does not exist
    • NoSuchThing if the symlink is broken
    \ No newline at end of file + (HPathIOException)

    Throws in Strict mode only:

    Note: calls rename (but does not allow to rename over existing files)

    File permissions

    newFilePerms :: FileMode Source

    Default permissions for a new file.

    newDirPerms :: FileMode Source

    Default permissions for a new directory.

    Directory reading

    getDirsFiles Source

    Arguments

    :: Path Abs

    dir to read

    -> IO [Path Abs] 

    Gets all filenames of the given directory. This excludes "." and "..". + This version does not follow symbolic links.

    The contents are not sorted and there is no guarantee on the ordering.

    Throws:

    • NoSuchThing if directory does not exist
    • InappropriateType if file type is wrong (file)
    • InappropriateType if file type is wrong (symlink to file)
    • InappropriateType if file type is wrong (symlink to dir)
    • PermissionDenied if directory cannot be opened

    Filetype operations

    getFileType :: Path Abs -> IO FileType Source

    Get the file type of the file located at the given path. Does + not follow symbolic links.

    Throws:

    • NoSuchThing if the file does not exist
    • PermissionDenied if any part of the path is not accessible

    Others

    canonicalizePath :: Path Abs -> IO (Path Abs) Source

    Applies realpath on the given absolute path.

    Throws:

    • NoSuchThing if the file at the given path does not exist
    • NoSuchThing if the symlink is broken
    \ No newline at end of file diff --git a/HPath.html b/HPath.html index bd0ab8e..20a8eca 100644 --- a/HPath.html +++ b/HPath.html @@ -1,8 +1,8 @@ -HPath

    hpath-0.8.0: Support for well-typed paths

    Copyright© 2015–2016 FP Complete, 2016 Julian Ospald
    LicenseBSD 3 clause
    MaintainerJulian Ospald <hasufell@posteo.de>
    Stabilityexperimental
    Portabilityportable
    Safe HaskellSafe
    LanguageHaskell2010

    HPath

    Description

    Support for well-typed paths.

    Synopsis

    Types

    data Abs Source #

    An absolute path.

    data Path b Source #

    Path of some base and type.

    Internally is a ByteString. The ByteString can be of two formats only:

    1. without trailing path separator: file.txt, foo/bar.txt, /foo/bar.txt
    2. with trailing path separator: foo/, /foo/bar/

    There are no duplicate - path separators //, no .., no ./, no ~/, etc.

    Instances

    Eq (Path b) Source #

    ByteString equality.

    The following property holds:

    show x == show y ≡ x == y

    Methods

    (==) :: Path b -> Path b -> Bool #

    (/=) :: Path b -> Path b -> Bool #

    Ord (Path b) Source #

    ByteString ordering.

    The following property holds:

    show x `compare` show y ≡ x `compare` y

    Methods

    compare :: Path b -> Path b -> Ordering #

    (<) :: Path b -> Path b -> Bool #

    (<=) :: Path b -> Path b -> Bool #

    (>) :: Path b -> Path b -> Bool #

    (>=) :: Path b -> Path b -> Bool #

    max :: Path b -> Path b -> Path b #

    min :: Path b -> Path b -> Path b #

    Show (Path b) Source #

    Same as toFilePath.

    The following property holds:

    x == y ≡ show x == show y

    Methods

    showsPrec :: Int -> Path b -> ShowS #

    show :: Path b -> String #

    showList :: [Path b] -> ShowS #

    NFData (Path b) Source # 

    Methods

    rnf :: Path b -> () #

    data Rel Source #

    A relative path; one without a root.

    Instances

    data Fn Source #

    A filename, without any /.

    Instances

    data PathParseException Source #

    Exception when parsing a location.

    Instances

    data PathException Source #

    Instances

    class RelC m Source #

    Instances

    PatternSynonyms/ViewPatterns

    pattern Path :: forall a. ByteString -> Path a Source #

    Path Parsing

    parseAbs :: MonadThrow m => ByteString -> m (Path Abs) Source #

    Get a location for an absolute path. Produces a normalised path.

    Throws: PathParseException

    >>> parseAbs "/abc"          :: Maybe (Path Abs)
+
    hpath-0.8.0: Support for well-typed paths
    Copyright© 2015–2016 FP Complete, 2016 Julian Ospald
    LicenseBSD 3 clause
    MaintainerJulian Ospald <hasufell@posteo.de>
    Stabilityexperimental
    Portabilityportable
    Safe HaskellSafe
    LanguageHaskell2010
    HPath
    Description
    Support for well-typed paths.
    Synopsis
    Types
    data Abs Source
    An absolute path.
    data Path b Source
    Path of some base and type.
    Internally is a ByteString. The ByteString can be of two formats only:
    1. without trailing path separator: file.txt, foo/bar.txt, /foo/bar.txt
    2. with trailing path separator: foo/, /foo/bar/
    There are no duplicate
+ path separators //, no .., no ./, no ~/, etc.
    Instances
    Eq (Path b) Source
    ByteString equality.
    The following property holds:
    show x == show y ≡ x == y
    Ord (Path b) Source
    ByteString ordering.
    The following property holds:
    show x `compare` show y ≡ x `compare` y
    Show (Path b) Source
    Same as toFilePath.
    The following property holds:
    x == y ≡ show x == show y
    NFData (Path b) Source 
    data Rel Source
    A relative path; one without a root.
    Instances
    data Fn Source
    A filename, without any /.
    Instances
    data PathParseException Source
    Exception when parsing a location.
    Instances
    data PathException Source
    Instances
    class RelC m Source
    Instances
    PatternSynonyms/ViewPatterns
    pattern Path ::   ByteString -> Path a Source
    Path Parsing
    parseAbs :: MonadThrow m => ByteString -> m (Path Abs) Source
    Get a location for an absolute path. Produces a normalised path.
    Throws: PathParseException
    >>> parseAbs "/abc"          :: Maybe (Path Abs)
 Just "/abc"
 >>> parseAbs "/"             :: Maybe (Path Abs)
 Just "/"
@@ -16,8 +16,8 @@ window.onload = function () {pageLoad();setSynopsis("mini_HPath.html");};
 Nothing
 >>> parseAbs "/abc/../foo"   :: Maybe (Path Abs)
 Nothing
-
    parseFn :: MonadThrow m => ByteString -> m (Path Fn) Source #
    Parses a filename. Filenames must not contain slashes.
- Excludes . and '..'.
    Throws: PathParseException
    >>> parseFn "abc"        :: Maybe (Path Fn)
+
    parseFn :: MonadThrow m => ByteString -> m (Path Fn) Source
    Parses a filename. Filenames must not contain slashes.
+ Excludes . and '..'.
    Throws: PathParseException
    >>> parseFn "abc"        :: Maybe (Path Fn)
 Just "abc"
 >>> parseFn "..."        :: Maybe (Path Fn)
 Just "..."
@@ -37,7 +37,7 @@ window.onload = function () {pageLoad();setSynopsis("mini_HPath.html");};
 Nothing
 >>> parseFn ".."         :: Maybe (Path Fn)
 Nothing
-
    parseRel :: MonadThrow m => ByteString -> m (Path Rel) Source #
    Get a location for a relative path. Produces a normalised
+

    parseRel :: MonadThrow m => ByteString -> m (Path Rel) Source

    Get a location for a relative path. Produces a normalised path.

    Note that filepath may contain any number of ./ but may not consist solely of ./. It also may not contain a single .. anywhere.

    Throws: PathParseException

    >>> parseRel "abc"        :: Maybe (Path Rel)
 Just "abc"
@@ -57,7 +57,7 @@ window.onload = function () {pageLoad();setSynopsis("mini_HPath.html");};
 Nothing
 >>> parseRel ".."         :: Maybe (Path Rel)
 Nothing
-

    Path Conversion

    fromAbs :: Path Abs -> ByteString Source #

    Convert an absolute Path to a ByteString type.

    fromRel :: RelC r => Path r -> ByteString Source #

    Convert a relative Path to a ByteString type.

    toFilePath :: Path b -> ByteString Source #

    Convert any Path to a ByteString type.

    Path Operations

    (</>) :: RelC r => Path b -> Path r -> Path b Source #

    Append two paths.

    The second argument must always be a relative path, which ensures +

    Path Conversion

    fromAbs :: Path Abs -> ByteString Source

    Convert an absolute Path to a ByteString type.

    fromRel :: RelC r => Path r -> ByteString Source

    Convert a relative Path to a ByteString type.

    toFilePath :: Path b -> ByteString Source

    Convert any Path to a ByteString type.

    Path Operations

    (</>) :: RelC r => Path b -> Path r -> Path b Source

    Append two paths.

    The second argument must always be a relative path, which ensures that undefinable things like `"abc" <> "/def"` cannot happen.

    Technically, the first argument can be a path that points to a non-directory, because this library is IO-agnostic and makes no assumptions about file types.

    >>> (MkPath "/")        </> (MkPath "file"     :: Path Rel)
@@ -68,17 +68,17 @@ window.onload = function () {pageLoad();setSynopsis("mini_HPath.html");};
 "/file/lal"
 >>> (MkPath "/")        </> (MkPath "file/"    :: Path Rel)
 "/file/"
-

    basename :: MonadThrow m => Path b -> m (Path Fn) Source #

    Extract the file part of a path.

    The following properties hold:

    basename (p </> a) == basename a

    Throws: PathException if given the root path "/"

    >>> basename (MkPath "/abc/def/dod") :: Maybe (Path Fn)
+

    basename :: MonadThrow m => Path b -> m (Path Fn) Source

    Extract the file part of a path.

    The following properties hold:

    basename (p </> a) == basename a

    Throws: PathException if given the root path "/"

    >>> basename (MkPath "/abc/def/dod") :: Maybe (Path Fn)
 Just "dod"
 >>> basename (MkPath "/abc/def/dod/") :: Maybe (Path Fn)
 Just "dod"
 >>> basename (MkPath "/")            :: Maybe (Path Fn)
 Nothing
-

    dirname :: Path Abs -> Path Abs Source #

    Extract the directory name of a path.

    The following properties hold:

    dirname (p </> a) == dirname p
    >>> dirname (MkPath "/abc/def/dod")
+

    dirname :: Path Abs -> Path Abs Source

    Extract the directory name of a path.

    The following properties hold:

    dirname (p </> a) == dirname p
    >>> dirname (MkPath "/abc/def/dod")
 "/abc/def"
 >>> dirname (MkPath "/")
 "/"
-

    isParentOf :: Path b -> Path b -> Bool Source #

    Is p a parent of the given location? Implemented in terms of +

    isParentOf :: Path b -> Path b -> Bool Source

    Is p a parent of the given location? Implemented in terms of stripDir. The bases must match.

    >>> (MkPath "/lal/lad")     `isParentOf` (MkPath "/lal/lad/fad")
 True
 >>> (MkPath "lal/lad")      `isParentOf` (MkPath "lal/lad/fad")
@@ -89,11 +89,11 @@ window.onload = function () {pageLoad();setSynopsis("mini_HPath.html");};
 False
 >>> (MkPath "fad")          `isParentOf` (MkPath "fad")
 False
-

    getAllParents :: Path Abs -> [Path Abs] Source #

    Get all parents of a path.

    >>> getAllParents (MkPath "/abs/def/dod")
+

    getAllParents :: Path Abs -> [Path Abs] Source

    Get all parents of a path.

    >>> getAllParents (MkPath "/abs/def/dod")
 ["/abs/def","/abs","/"]
 >>> getAllParents (MkPath "/")
 []
-

    stripDir :: MonadThrow m => Path b -> Path b -> m (Path Rel) Source #

    Strip directory from path, making it relative to that directory. +

    stripDir :: MonadThrow m => Path b -> Path b -> m (Path Rel) Source

    Strip directory from path, making it relative to that directory. Throws Couldn'tStripPrefixDir if directory is not a parent of the path.

    The bases must match.

    >>> (MkPath "/lal/lad")     `stripDir` (MkPath "/lal/lad/fad") :: Maybe (Path Rel)
 Just "fad"
 >>> (MkPath "lal/lad")      `stripDir` (MkPath "lal/lad/fad")  :: Maybe (Path Rel)
@@ -104,4 +104,4 @@ window.onload = function () {pageLoad();setSynopsis("mini_HPath.html");};
 Nothing
 >>> (MkPath "fad")          `stripDir` (MkPath "fad")          :: Maybe (Path Rel)
 Nothing
-

    Path IO helpers

    withAbsPath :: Path Abs -> (ByteString -> IO a) -> IO a Source #

    withRelPath :: Path Rel -> (ByteString -> IO a) -> IO a Source #

    withFnPath :: Path Fn -> (ByteString -> IO a) -> IO a Source #

    \ No newline at end of file +

    Path IO helpers

    withAbsPath :: Path Abs -> (ByteString -> IO a) -> IO a Source

    withRelPath :: Path Rel -> (ByteString -> IO a) -> IO a Source

    withFnPath :: Path Fn -> (ByteString -> IO a) -> IO a Source

    \ No newline at end of file diff --git a/System-Posix-Directory-Foreign.html b/System-Posix-Directory-Foreign.html index e17f18a..351f179 100644 --- a/System-Posix-Directory-Foreign.html +++ b/System-Posix-Directory-Foreign.html @@ -1,9 +1,9 @@ -System.Posix.Directory.Foreign

    hpath-0.8.0: Support for well-typed paths

    Safe HaskellSafe
    LanguageHaskell2010

    System.Posix.Directory.Foreign

    Documentation

    newtype DirType Source #

    Constructors

    DirType Int 

    Instances

    data Flags Source #

    Constructors

    Flags Int 
    UnsupportedFlag String 

    Instances

    Eq Flags Source # 

    Methods

    (==) :: Flags -> Flags -> Bool #

    (/=) :: Flags -> Flags -> Bool #

    Show Flags Source # 

    Methods

    showsPrec :: Int -> Flags -> ShowS #

    show :: Flags -> String #

    showList :: [Flags] -> ShowS #

    unFlags :: Flags -> Int Source #

    isSupported :: Flags -> Bool Source #

    Returns True if posix-paths was compiled with support for the provided +

    hpath-0.8.0: Support for well-typed paths

    Safe HaskellSafe
    LanguageHaskell2010

    System.Posix.Directory.Foreign

    Documentation

    newtype DirType Source

    Constructors

    DirType Int 

    Instances

    data Flags Source

    Constructors

    Flags Int 
    UnsupportedFlag String 

    Instances

    unFlags :: Flags -> Int Source

    isSupported :: Flags -> Bool Source

    Returns True if posix-paths was compiled with support for the provided flag. (As of this writing, the only flag for which this check may be - necessary is oCloexec; all other flags will always yield True.)

    oCloexec :: Flags Source #

    O_CLOEXEC is not supported on every POSIX platform. Use + necessary is oCloexec; all other flags will always yield True.)

    oCloexec :: Flags Source

    O_CLOEXEC is not supported on every POSIX platform. Use isSupported oCloexec to determine if support for O_CLOEXEC was compiled into your version of posix-paths. (If not, using oCloexec will - throw an exception.)

    dtBlk :: DirType Source #

    oAppend :: Flags Source #

    dtChr :: DirType Source #

    pathMax :: Int Source #

    oAsync :: Flags Source #

    dtDir :: DirType Source #

    oCreat :: Flags Source #

    dtFifo :: DirType Source #

    unionFlags :: [Flags] -> CInt Source #

    dtLnk :: DirType Source #

    oDirectory :: Flags Source #

    oExcl :: Flags Source #

    dtReg :: DirType Source #

    oNoctty :: Flags Source #

    dtSock :: DirType Source #

    oNofollow :: Flags Source #

    dtUnknown :: DirType Source #

    oNonblock :: Flags Source #

    oRdonly :: Flags Source #

    oWronly :: Flags Source #

    oRdwr :: Flags Source #

    oSync :: Flags Source #

    oTrunc :: Flags Source #

    \ No newline at end of file + throw an exception.)

    dtBlk :: DirType Source

    oAppend :: Flags Source

    dtChr :: DirType Source

    pathMax :: Int Source

    oAsync :: Flags Source

    dtDir :: DirType Source

    oCreat :: Flags Source

    dtFifo :: DirType Source

    unionFlags :: [Flags] -> CInt Source

    dtLnk :: DirType Source

    oDirectory :: Flags Source

    oExcl :: Flags Source

    dtReg :: DirType Source

    oNoctty :: Flags Source

    dtSock :: DirType Source

    oNofollow :: Flags Source

    dtUnknown :: DirType Source

    oNonblock :: Flags Source

    oRdonly :: Flags Source

    oWronly :: Flags Source

    oRdwr :: Flags Source

    oSync :: Flags Source

    oTrunc :: Flags Source

    \ No newline at end of file diff --git a/System-Posix-Directory-Traversals.html b/System-Posix-Directory-Traversals.html index 7d6b8a9..ef3590a 100644 --- a/System-Posix-Directory-Traversals.html +++ b/System-Posix-Directory-Traversals.html @@ -1,11 +1,11 @@ -System.Posix.Directory.Traversals

    hpath-0.8.0: Support for well-typed paths

    Copyright© 2016 Julian Ospald
    LicenseBSD3
    MaintainerJulian Ospald <hasufell@posteo.de>
    Stabilityexperimental
    Portabilityportable
    Safe HaskellNone
    LanguageHaskell2010

    System.Posix.Directory.Traversals

    Description

    Traversal and read operations on directories.

    Documentation

    getDirectoryContents :: RawFilePath -> IO [(DirType, RawFilePath)] Source #

    Gets all directory contents (not recursively).

    getDirectoryContents' :: Fd -> IO [(DirType, RawFilePath)] Source #

    Like getDirectoryContents except for a file descriptor.

    To avoid complicated error checks, the file descriptor is +

    hpath-0.8.0: Support for well-typed paths

    Copyright© 2016 Julian Ospald
    LicenseBSD3
    MaintainerJulian Ospald <hasufell@posteo.de>
    Stabilityexperimental
    Portabilityportable
    Safe HaskellNone
    LanguageHaskell2010

    System.Posix.Directory.Traversals

    Description

    Traversal and read operations on directories.

    Documentation

    getDirectoryContents :: RawFilePath -> IO [(DirType, RawFilePath)] Source

    Gets all directory contents (not recursively).

    getDirectoryContents' :: Fd -> IO [(DirType, RawFilePath)] Source

    Like getDirectoryContents except for a file descriptor.

    To avoid complicated error checks, the file descriptor is always closed, even if fdOpendir fails. Usually, this only happens on successful fdOpendir and after the directory stream is closed. Also see the manpage of fdopendir(3) for - more details.

    allDirectoryContents :: RawFilePath -> IO [RawFilePath] Source #

    Get all files from a directory and its subdirectories.

    Upon entering a directory, allDirectoryContents will get all entries + more details.

    allDirectoryContents :: RawFilePath -> IO [RawFilePath] Source

    Get all files from a directory and its subdirectories.

    Upon entering a directory, allDirectoryContents will get all entries strictly. However the returned list is lazy in that directories will only - be accessed on demand.

    Follows symbolic links for the input dir.

    allDirectoryContents' :: RawFilePath -> IO [RawFilePath] Source #

    Get all files from a directory and its subdirectories strictly.

    Follows symbolic links for the input dir.

    traverseDirectory :: (s -> RawFilePath -> IO s) -> s -> RawFilePath -> IO s Source #

    Recursively apply the action to the parent directory and all - files/subdirectories.

    This function allows for memory-efficient traversals.

    Follows symbolic links for the input dir.

    readDirEnt :: DirStream -> IO (DirType, RawFilePath) Source #

    packDirStream :: Ptr CDir -> DirStream Source #

    unpackDirStream :: DirStream -> Ptr CDir Source #

    fdOpendir :: Fd -> IO DirStream Source #

    Binding to fdopendir(3).

    realpath :: RawFilePath -> IO RawFilePath Source #

    return the canonicalized absolute pathname

    like canonicalizePath, but uses realpath(3)

    \ No newline at end of file + be accessed on demand.

    Follows symbolic links for the input dir.

    allDirectoryContents' :: RawFilePath -> IO [RawFilePath] Source

    Get all files from a directory and its subdirectories strictly.

    Follows symbolic links for the input dir.

    traverseDirectory :: (s -> RawFilePath -> IO s) -> s -> RawFilePath -> IO s Source

    Recursively apply the action to the parent directory and all + files/subdirectories.

    This function allows for memory-efficient traversals.

    Follows symbolic links for the input dir.

    readDirEnt :: DirStream -> IO (DirType, RawFilePath) Source

    packDirStream :: Ptr CDir -> DirStream Source

    unpackDirStream :: DirStream -> Ptr CDir Source

    fdOpendir :: Fd -> IO DirStream Source

    Binding to fdopendir(3).

    realpath :: RawFilePath -> IO RawFilePath Source

    return the canonicalized absolute pathname

    like canonicalizePath, but uses realpath(3)

    \ No newline at end of file diff --git a/System-Posix-FD.html b/System-Posix-FD.html index 46d11ae..2a83b73 100644 --- a/System-Posix-FD.html +++ b/System-Posix-FD.html @@ -1,9 +1,9 @@ -System.Posix.FD

    hpath-0.8.0: Support for well-typed paths

    Copyright© 2016 Julian Ospald
    LicenseBSD3
    MaintainerJulian Ospald <hasufell@posteo.de>
    Stabilityexperimental
    Portabilityportable
    Safe HaskellSafe
    LanguageHaskell2010

    System.Posix.FD

    Description

    Provides an alternative for openFd +

    hpath-0.8.0: Support for well-typed paths

    Copyright© 2016 Julian Ospald
    LicenseBSD3
    MaintainerJulian Ospald <hasufell@posteo.de>
    Stabilityexperimental
    Portabilityportable
    Safe HaskellSafe
    LanguageHaskell2010

    System.Posix.FD

    Description

    Provides an alternative for openFd which gives us more control on what status flags to pass to the - low-level open(2) call, in contrast to the unix package.

    Synopsis

    Documentation

    openFd Source #

    Arguments

    :: RawFilePath 
    -> OpenMode 
    -> [Flags]

    status flags of open(2)

    -> Maybe FileMode

    Just x => creates the file with the given modes, Nothing => the file must exist.

    -> IO Fd 

    Open and optionally create this file. See Files + low-level open(2) call, in contrast to the unix package.

    Synopsis

    Documentation

    openFd Source

    Arguments

    :: RawFilePath 
    -> OpenMode 
    -> [Flags]

    status flags of open(2)

    -> Maybe FileMode

    Just x => creates the file with the given modes, Nothing => the file must exist.

    -> IO Fd 

    Open and optionally create this file. See Files for information on how to use the FileMode type.

    Note that passing Just x as the 4th argument triggers the oCreat status flag, which must be set when you pass in oExcl - to the status flags. Also see the manpage for open(2).

    \ No newline at end of file + to the status flags. Also see the manpage for open(2).

    \ No newline at end of file diff --git a/System-Posix-FilePath.html b/System-Posix-FilePath.html index da58952..756825a 100644 --- a/System-Posix-FilePath.html +++ b/System-Posix-FilePath.html @@ -1,7 +1,7 @@ -System.Posix.FilePath

    hpath-0.8.0: Support for well-typed paths

    Copyright© 2016 Julian Ospald
    LicenseBSD3
    MaintainerJulian Ospald <hasufell@posteo.de>
    Stabilityexperimental
    Portabilityportable
    Safe HaskellSafe
    LanguageHaskell2010

    System.Posix.FilePath

    Description

    The equivalent of System.FilePath on raw (byte string) file paths.

    Not all functions of System.FilePath are implemented yet. Feel free to contribute!

    Synopsis

    Separator predicates

    pathSeparator :: Word8 Source #

    Path separator character

    isPathSeparator :: Word8 -> Bool Source #

    Check if a character is the path separator

    \n ->  (_chr n == '/') == isPathSeparator n

    searchPathSeparator :: Word8 Source #

    Search path separator

    isSearchPathSeparator :: Word8 -> Bool Source #

    Check if a character is the search path separator

    \n -> (_chr n == ':') == isSearchPathSeparator n

    extSeparator :: Word8 Source #

    File extension separator

    isExtSeparator :: Word8 -> Bool Source #

    Check if a character is the file extension separator

    \n -> (_chr n == '.') == isExtSeparator n

    $PATH methods

    splitSearchPath :: ByteString -> [RawFilePath] Source #

    Take a ByteString, split it on the searchPathSeparator. +

    hpath-0.8.0: Support for well-typed paths

    Copyright© 2016 Julian Ospald
    LicenseBSD3
    MaintainerJulian Ospald <hasufell@posteo.de>
    Stabilityexperimental
    Portabilityportable
    Safe HaskellSafe
    LanguageHaskell2010

    System.Posix.FilePath

    Description

    The equivalent of System.FilePath on raw (byte string) file paths.

    Not all functions of System.FilePath are implemented yet. Feel free to contribute!

    Synopsis

    Separator predicates

    pathSeparator :: Word8 Source

    Path separator character

    isPathSeparator :: Word8 -> Bool Source

    Check if a character is the path separator

    \n ->  (_chr n == '/') == isPathSeparator n

    searchPathSeparator :: Word8 Source

    Search path separator

    isSearchPathSeparator :: Word8 -> Bool Source

    Check if a character is the search path separator

    \n -> (_chr n == ':') == isSearchPathSeparator n

    extSeparator :: Word8 Source

    File extension separator

    isExtSeparator :: Word8 -> Bool Source

    Check if a character is the file extension separator

    \n -> (_chr n == '.') == isExtSeparator n

    $PATH methods

    splitSearchPath :: ByteString -> [RawFilePath] Source

    Take a ByteString, split it on the searchPathSeparator. Blank items are converted to ..

    Follows the recommendations in http://www.opengroup.org/onlinepubs/009695399/basedefs/xbd_chap08.html

    >>> splitSearchPath "File1:File2:File3"
 ["File1","File2","File3"]
@@ -9,45 +9,45 @@ window.onload = function () {pageLoad();setSynopsis("mini_System-Posix-FilePath.
 ["File1",".","File2","File3"]
 >>> splitSearchPath ""
 ["."]
-

    getSearchPath :: IO [RawFilePath] Source #

    Get a list of RawFilePaths in the $PATH variable.

    Extension functions

    splitExtension :: RawFilePath -> (RawFilePath, ByteString) Source #

    Split a RawFilePath into a path+filename and extension

    >>> splitExtension "file.exe"
+

    getSearchPath :: IO [RawFilePath] Source

    Get a list of RawFilePaths in the $PATH variable.

    Extension functions

    splitExtension :: RawFilePath -> (RawFilePath, ByteString) Source

    Split a RawFilePath into a path+filename and extension

    >>> splitExtension "file.exe"
 ("file",".exe")
 >>> splitExtension "file"
 ("file","")
 >>> splitExtension "/path/file.tar.gz"
 ("/path/file.tar",".gz")
-
    \path -> uncurry (BS.append) (splitExtension path) == path

    takeExtension :: RawFilePath -> ByteString Source #

    Get the final extension from a RawFilePath

    >>> takeExtension "file.exe"
+
    \path -> uncurry (BS.append) (splitExtension path) == path

    takeExtension :: RawFilePath -> ByteString Source

    Get the final extension from a RawFilePath

    >>> takeExtension "file.exe"
 ".exe"
 >>> takeExtension "file"
 ""
 >>> takeExtension "/path/file.tar.gz"
 ".gz"
-

    replaceExtension :: RawFilePath -> ByteString -> RawFilePath Source #

    Change a file's extension

    \path -> let ext = takeExtension path in replaceExtension path ext == path

    dropExtension :: RawFilePath -> RawFilePath Source #

    Drop the final extension from a RawFilePath

    >>> dropExtension "file.exe"
+

    replaceExtension :: RawFilePath -> ByteString -> RawFilePath Source

    Change a file's extension

    \path -> let ext = takeExtension path in replaceExtension path ext == path

    dropExtension :: RawFilePath -> RawFilePath Source

    Drop the final extension from a RawFilePath

    >>> dropExtension "file.exe"
 "file"
 >>> dropExtension "file"
 "file"
 >>> dropExtension "/path/file.tar.gz"
 "/path/file.tar"
-

    addExtension :: RawFilePath -> ByteString -> RawFilePath Source #

    Add an extension to a RawFilePath

    >>> addExtension "file" ".exe"
+

    addExtension :: RawFilePath -> ByteString -> RawFilePath Source

    Add an extension to a RawFilePath

    >>> addExtension "file" ".exe"
 "file.exe"
 >>> addExtension "file.tar" ".gz"
 "file.tar.gz"
 >>> addExtension "/path/" ".ext"
 "/path/.ext"
-

    hasExtension :: RawFilePath -> Bool Source #

    Check if a RawFilePath has an extension

    >>> hasExtension "file"
+

    hasExtension :: RawFilePath -> Bool Source

    Check if a RawFilePath has an extension

    >>> hasExtension "file"
 False
 >>> hasExtension "file.tar"
 True
 >>> hasExtension "/path.part1/"
 False
-

    (<.>) :: RawFilePath -> ByteString -> RawFilePath Source #

    Operator version of addExtension

    splitExtensions :: RawFilePath -> (RawFilePath, ByteString) Source #

    Split a RawFilePath on the first extension.

    >>> splitExtensions "/path/file.tar.gz"
+

    (<.>) :: RawFilePath -> ByteString -> RawFilePath Source

    Operator version of addExtension

    splitExtensions :: RawFilePath -> (RawFilePath, ByteString) Source

    Split a RawFilePath on the first extension.

    >>> splitExtensions "/path/file.tar.gz"
 ("/path/file",".tar.gz")
-
    \path -> uncurry addExtension (splitExtensions path) == path

    dropExtensions :: RawFilePath -> RawFilePath Source #

    Remove all extensions from a RawFilePath

    >>> dropExtensions "/path/file.tar.gz"
+
    \path -> uncurry addExtension (splitExtensions path) == path

    dropExtensions :: RawFilePath -> RawFilePath Source

    Remove all extensions from a RawFilePath

    >>> dropExtensions "/path/file.tar.gz"
 "/path/file"
-

    takeExtensions :: RawFilePath -> ByteString Source #

    Take all extensions from a RawFilePath

    >>> takeExtensions "/path/file.tar.gz"
+

    takeExtensions :: RawFilePath -> ByteString Source

    Take all extensions from a RawFilePath

    >>> takeExtensions "/path/file.tar.gz"
 ".tar.gz"
-

    stripExtension :: ByteString -> RawFilePath -> Maybe RawFilePath Source #

    Drop the given extension from a FilePath, and the "." preceding it. - Returns Nothing if the FilePath does not have the given extension, or - Just and the part before the extension if it does.

    This function can be more predictable than dropExtensions, +

    stripExtension :: ByteString -> RawFilePath -> Maybe RawFilePath Source

    Drop the given extension from a FilePath, and the "." preceding it. + Returns Nothing if the FilePath does not have the given extension, or + Just and the part before the extension if it does.

    This function can be more predictable than dropExtensions, especially if the filename might itself contain . characters.

    >>> stripExtension "hs.o" "foo.x.hs.o"
 Just "foo.x"
 >>> stripExtension "hi.o" "foo.x.hs.o"
@@ -60,27 +60,27 @@ window.onload = function () {pageLoad();setSynopsis("mini_System-Posix-FilePath.
 Nothing
 >>> stripExtension "bar"  "foobar"
 Nothing
-
    \path -> stripExtension "" path == Just path
    \path -> dropExtension path  == fromJust (stripExtension (takeExtension path) path)
    \path -> dropExtensions path == fromJust (stripExtension (takeExtensions path) path)

    Filename/directory functions

    splitFileName :: RawFilePath -> (RawFilePath, RawFilePath) Source #

    Split a RawFilePath into (path,file). combine is the inverse

    >>> splitFileName "path/file.txt"
+
    \path -> stripExtension "" path == Just path
    \path -> dropExtension path  == fromJust (stripExtension (takeExtension path) path)
    \path -> dropExtensions path == fromJust (stripExtension (takeExtensions path) path)

    Filename/directory functions

    splitFileName :: RawFilePath -> (RawFilePath, RawFilePath) Source

    Split a RawFilePath into (path,file). combine is the inverse

    >>> splitFileName "path/file.txt"
 ("path/","file.txt")
 >>> splitFileName "path/"
 ("path/","")
 >>> splitFileName "file.txt"
 ("./","file.txt")
-
    \path -> uncurry combine (splitFileName path) == path || fst (splitFileName path) == "./"

    takeFileName :: RawFilePath -> RawFilePath Source #

    Get the file name

    >>> takeFileName "path/file.txt"
+
    \path -> uncurry combine (splitFileName path) == path || fst (splitFileName path) == "./"

    takeFileName :: RawFilePath -> RawFilePath Source

    Get the file name

    >>> takeFileName "path/file.txt"
 "file.txt"
 >>> takeFileName "path/"
 ""
-

    replaceFileName :: RawFilePath -> ByteString -> RawFilePath Source #

    Change the file name

    \path -> replaceFileName path (takeFileName path) == path

    dropFileName :: RawFilePath -> RawFilePath Source #

    Drop the file name

    >>> dropFileName "path/file.txt"
+

    replaceFileName :: RawFilePath -> ByteString -> RawFilePath Source

    Change the file name

    \path -> replaceFileName path (takeFileName path) == path

    dropFileName :: RawFilePath -> RawFilePath Source

    Drop the file name

    >>> dropFileName "path/file.txt"
 "path/"
 >>> dropFileName "file.txt"
 "./"
-

    takeBaseName :: RawFilePath -> ByteString Source #

    Get the file name, without a trailing extension

    >>> takeBaseName "path/file.tar.gz"
+

    takeBaseName :: RawFilePath -> ByteString Source

    Get the file name, without a trailing extension

    >>> takeBaseName "path/file.tar.gz"
 "file.tar"
 >>> takeBaseName ""
 ""
-

    replaceBaseName :: RawFilePath -> ByteString -> RawFilePath Source #

    Change the base name

    >>> replaceBaseName "path/file.tar.gz" "bob"
+

    replaceBaseName :: RawFilePath -> ByteString -> RawFilePath Source

    Change the base name

    >>> replaceBaseName "path/file.tar.gz" "bob"
 "path/bob.gz"
-
    \path -> replaceBaseName path (takeBaseName path) == path

    takeDirectory :: RawFilePath -> RawFilePath Source #

    Get the directory, moving up one level if it's already a directory

    >>> takeDirectory "path/file.txt"
+
    \path -> replaceBaseName path (takeBaseName path) == path

    takeDirectory :: RawFilePath -> RawFilePath Source

    Get the directory, moving up one level if it's already a directory

    >>> takeDirectory "path/file.txt"
 "path"
 >>> takeDirectory "file"
 "."
@@ -88,33 +88,33 @@ window.onload = function () {pageLoad();setSynopsis("mini_System-Posix-FilePath.
 "/path/to"
 >>> takeDirectory "/path/to"
 "/path"
-

    replaceDirectory :: RawFilePath -> ByteString -> RawFilePath Source #

    Change the directory component of a RawFilePath

    \path -> replaceDirectory path (takeDirectory path) `equalFilePath` path || takeDirectory path == "."

    combine :: RawFilePath -> RawFilePath -> RawFilePath Source #

    Join two paths together

    >>> combine "/" "file"
+

    replaceDirectory :: RawFilePath -> ByteString -> RawFilePath Source

    Change the directory component of a RawFilePath

    \path -> replaceDirectory path (takeDirectory path) `equalFilePath` path || takeDirectory path == "."

    combine :: RawFilePath -> RawFilePath -> RawFilePath Source

    Join two paths together

    >>> combine "/" "file"
 "/file"
 >>> combine "/path/to" "file"
 "/path/to/file"
 >>> combine "file" "/absolute/path"
 "/absolute/path"
-

    (</>) :: RawFilePath -> RawFilePath -> RawFilePath Source #

    Operator version of combine

    splitPath :: RawFilePath -> [RawFilePath] Source #

    Split a path into a list of components:

    >>> splitPath "/path/to/file.txt"
+

    (</>) :: RawFilePath -> RawFilePath -> RawFilePath Source

    Operator version of combine

    splitPath :: RawFilePath -> [RawFilePath] Source

    Split a path into a list of components:

    >>> splitPath "/path/to/file.txt"
 ["/","path/","to/","file.txt"]
-
    \path -> BS.concat (splitPath path) == path

    joinPath :: [RawFilePath] -> RawFilePath Source #

    Join a split path back together

    \path -> joinPath (splitPath path) == path
    >>> joinPath ["path","to","file.txt"]
+
    \path -> BS.concat (splitPath path) == path

    joinPath :: [RawFilePath] -> RawFilePath Source

    Join a split path back together

    \path -> joinPath (splitPath path) == path
    >>> joinPath ["path","to","file.txt"]
 "path/to/file.txt"
-

    splitDirectories :: RawFilePath -> [RawFilePath] Source #

    Like splitPath, but without trailing slashes

    >>> splitDirectories "/path/to/file.txt"
+

    splitDirectories :: RawFilePath -> [RawFilePath] Source

    Like splitPath, but without trailing slashes

    >>> splitDirectories "/path/to/file.txt"
 ["/","path","to","file.txt"]
 >>> splitDirectories ""
 []
-

    Trailing slash functions

    hasTrailingPathSeparator :: RawFilePath -> Bool Source #

    Check if the last character of a RawFilePath is /.

    >>> hasTrailingPathSeparator "/path/"
+

    Trailing slash functions

    hasTrailingPathSeparator :: RawFilePath -> Bool Source

    Check if the last character of a RawFilePath is /.

    >>> hasTrailingPathSeparator "/path/"
 True
 >>> hasTrailingPathSeparator "/"
 True
 >>> hasTrailingPathSeparator "/path"
 False
-

    addTrailingPathSeparator :: RawFilePath -> RawFilePath Source #

    Add a trailing path separator.

    >>> addTrailingPathSeparator "/path"
+

    addTrailingPathSeparator :: RawFilePath -> RawFilePath Source

    Add a trailing path separator.

    >>> addTrailingPathSeparator "/path"
 "/path/"
 >>> addTrailingPathSeparator "/path/"
 "/path/"
 >>> addTrailingPathSeparator "/"
 "/"
-

    dropTrailingPathSeparator :: RawFilePath -> RawFilePath Source #

    Remove a trailing path separator

    >>> dropTrailingPathSeparator "/path/"
+

    dropTrailingPathSeparator :: RawFilePath -> RawFilePath Source

    Remove a trailing path separator

    >>> dropTrailingPathSeparator "/path/"
 "/path"
 >>> dropTrailingPathSeparator "/path////"
 "/path"
@@ -122,7 +122,7 @@ window.onload = function () {pageLoad();setSynopsis("mini_System-Posix-FilePath.
 "/"
 >>> dropTrailingPathSeparator "//"
 "/"
-

    File name manipulations

    normalise :: RawFilePath -> RawFilePath Source #

    Normalise a file.

    >>> normalise "/file/\\test////"
+

    File name manipulations

    normalise :: RawFilePath -> RawFilePath Source

    Normalise a file.

    >>> normalise "/file/\\test////"
 "/file/\\test/"
 >>> normalise "/file/./test"
 "/file/test"
@@ -148,7 +148,7 @@ window.onload = function () {pageLoad();setSynopsis("mini_System-Posix-FilePath.
 "bob/fred/"
 >>> normalise "//home"
 "/home"
-

    makeRelative :: RawFilePath -> RawFilePath -> RawFilePath Source #

    Contract a filename, based on a relative path. Note that the resulting +

    makeRelative :: RawFilePath -> RawFilePath -> RawFilePath Source

    Contract a filename, based on a relative path. Note that the resulting path will never introduce .. paths, as the presence of symlinks means ../b may not reach a/b if it starts from a/c. For a worked example see @@ -166,7 +166,7 @@ window.onload = function () {pageLoad();setSynopsis("mini_System-Posix-FilePath. "fred/" >>> makeRelative "some/path" "some/path/a/b/c" "a/b/c" -

    \p -> makeRelative p p == "."
    \p -> makeRelative (takeDirectory p) p `equalFilePath` takeFileName p

    prop x y -> equalFilePath x y || (isRelative x && makeRelative y x == x) || equalFilePath (y / makeRelative y x) x

    equalFilePath :: RawFilePath -> RawFilePath -> Bool Source #

    Equality of two filepaths. The filepaths are normalised +

    \p -> makeRelative p p == "."
    \p -> makeRelative (takeDirectory p) p `equalFilePath` takeFileName p

    prop x y -> equalFilePath x y || (isRelative x && makeRelative y x == x) || equalFilePath (y / makeRelative y x) x

    equalFilePath :: RawFilePath -> RawFilePath -> Bool Source

    Equality of two filepaths. The filepaths are normalised and trailing path separators are dropped.

    >>> equalFilePath "foo" "foo"
 True
 >>> equalFilePath "foo" "foo/"
@@ -181,23 +181,23 @@ window.onload = function () {pageLoad();setSynopsis("mini_System-Posix-FilePath.
 False
 >>> equalFilePath "foo" "../foo"
 False
-
    \p -> equalFilePath p p

    isRelative :: RawFilePath -> Bool Source #

    Check if a path is relative

    \path -> isRelative path /= isAbsolute path

    isAbsolute :: RawFilePath -> Bool Source #

    Check if a path is absolute

    >>> isAbsolute "/path"
+
    \p -> equalFilePath p p

    isRelative :: RawFilePath -> Bool Source

    Check if a path is relative

    \path -> isRelative path /= isAbsolute path

    isAbsolute :: RawFilePath -> Bool Source

    Check if a path is absolute

    >>> isAbsolute "/path"
 True
 >>> isAbsolute "path"
 False
 >>> isAbsolute ""
 False
-

    isValid :: RawFilePath -> Bool Source #

    Is a FilePath valid, i.e. could you create a file like it?

    >>> isValid ""
+

    isValid :: RawFilePath -> Bool Source

    Is a FilePath valid, i.e. could you create a file like it?

    >>> isValid ""
 False
 >>> isValid "\0"
 False
 >>> isValid "/random_ path:*"
 True
-

    makeValid :: RawFilePath -> RawFilePath Source #

    Take a FilePath and make it valid; does not change already valid FilePaths.

    >>> makeValid ""
+

    makeValid :: RawFilePath -> RawFilePath Source

    Take a FilePath and make it valid; does not change already valid FilePaths.

    >>> makeValid ""
 "_"
 >>> makeValid "file\0name"
 "file_name"
-
    \p -> if isValid p then makeValid p == p else makeValid p /= p
    \p -> isValid (makeValid p)

    isFileName :: RawFilePath -> Bool Source #

    Is the given path a valid filename? This includes +

    \p -> if isValid p then makeValid p == p else makeValid p /= p
    \p -> isValid (makeValid p)

    isFileName :: RawFilePath -> Bool Source

    Is the given path a valid filename? This includes "." and "..".

    >>> isFileName "lal"
 True
 >>> isFileName "."
@@ -210,7 +210,7 @@ window.onload = function () {pageLoad();setSynopsis("mini_System-Posix-FilePath.
 False
 >>> isFileName "/random_ path:*"
 False
-

    hasParentDir :: RawFilePath -> Bool Source #

    Check if the filepath has any parent directories in it.

    >>> hasParentDir "/.."
+

    hasParentDir :: RawFilePath -> Bool Source

    Check if the filepath has any parent directories in it.

    >>> hasParentDir "/.."
 True
 >>> hasParentDir "foo/bar/.."
 True
@@ -224,7 +224,7 @@ window.onload = function () {pageLoad();setSynopsis("mini_System-Posix-FilePath.
 False
 >>> hasParentDir ".."
 False
-

    hiddenFile :: RawFilePath -> Bool Source #

    Whether the file is a hidden file.

    >>> hiddenFile ".foo"
+

    hiddenFile :: RawFilePath -> Bool Source

    Whether the file is a hidden file.

    >>> hiddenFile ".foo"
 True
 >>> hiddenFile "..foo.bar"
 True
@@ -240,4 +240,4 @@ window.onload = function () {pageLoad();setSynopsis("mini_System-Posix-FilePath.
 False
 >>> hiddenFile ""
 False
-

    module System.Posix.ByteString.FilePath

    \ No newline at end of file +

    module System.Posix.ByteString.FilePath

    \ No newline at end of file diff --git a/doc-index-60.html b/doc-index-60.html index 61d5e1f..02a58de 100644 --- a/doc-index-60.html +++ b/doc-index-60.html @@ -1,4 +1,4 @@ -hpath-0.8.0: Support for well-typed paths (Index - <)

    hpath-0.8.0: Support for well-typed paths

    Index - <

    <.>System.Posix.FilePath
    </> 
    1 (Function)System.Posix.FilePath
    2 (Function)HPath
    \ No newline at end of file +

    hpath-0.8.0: Support for well-typed paths

    Index - <

    <.>System.Posix.FilePath
    </> 
    1 (Function)System.Posix.FilePath
    2 (Function)HPath
    \ No newline at end of file diff --git a/doc-index-A.html b/doc-index-A.html index 3d29689..769fc73 100644 --- a/doc-index-A.html +++ b/doc-index-A.html @@ -1,4 +1,4 @@ -hpath-0.8.0: Support for well-typed paths (Index - A)

    hpath-0.8.0: Support for well-typed paths

    Index - A

    AbsHPath
    addExtensionSystem.Posix.FilePath
    addTrailingPathSeparatorSystem.Posix.FilePath
    allDirectoryContentsSystem.Posix.Directory.Traversals
    allDirectoryContents'System.Posix.Directory.Traversals
    \ No newline at end of file +

    hpath-0.8.0: Support for well-typed paths

    Index - A

    AbsHPath
    addExtensionSystem.Posix.FilePath
    addTrailingPathSeparatorSystem.Posix.FilePath
    allDirectoryContentsSystem.Posix.Directory.Traversals
    allDirectoryContents'System.Posix.Directory.Traversals
    \ No newline at end of file diff --git a/doc-index-All.html b/doc-index-All.html index 9e8d1b7..02a9ee0 100644 --- a/doc-index-All.html +++ b/doc-index-All.html @@ -1,4 +1,4 @@ -hpath-0.8.0: Support for well-typed paths (Index)

    hpath-0.8.0: Support for well-typed paths

    Index

    <.>System.Posix.FilePath
    </> 
    1 (Function)System.Posix.FilePath
    2 (Function)HPath
    AbsHPath
    addExtensionSystem.Posix.FilePath
    addTrailingPathSeparatorSystem.Posix.FilePath
    allDirectoryContentsSystem.Posix.Directory.Traversals
    allDirectoryContents'System.Posix.Directory.Traversals
    basenameHPath
    BlockDeviceHPath.IO
    bracketeerHPath.IO.Errors
    canonicalizePathHPath.IO
    canOpenDirectoryHPath.IO.Errors
    catchErrnoHPath.IO.Errors
    CharacterDeviceHPath.IO
    CollectFailuresHPath.IO
    combineSystem.Posix.FilePath
    copyDirRecursiveHPath.IO
    copyFileHPath.IO
    CopyFileFailedHPath.IO.Errors
    CopyModeHPath.IO
    createDirHPath.IO
    CreateDirFailedHPath.IO.Errors
    createDirRecursiveHPath.IO
    createRegularFileHPath.IO
    createSymlinkHPath.IO
    deleteDirHPath.IO
    deleteDirRecursiveHPath.IO
    deleteFileHPath.IO
    DestinationInSourceHPath.IO.Errors
    DirectoryHPath.IO
    dirnameHPath
    DirType 
    1 (Type/Class)System.Posix.Directory.Foreign
    2 (Data Constructor)System.Posix.Directory.Foreign
    doesDirectoryExistHPath.IO.Errors
    doesFileExistHPath.IO.Errors
    dropExtensionSystem.Posix.FilePath
    dropExtensionsSystem.Posix.FilePath
    dropFileNameSystem.Posix.FilePath
    dropTrailingPathSeparatorSystem.Posix.FilePath
    dtBlkSystem.Posix.Directory.Foreign
    dtChrSystem.Posix.Directory.Foreign
    dtDirSystem.Posix.Directory.Foreign
    dtFifoSystem.Posix.Directory.Foreign
    dtLnkSystem.Posix.Directory.Foreign
    dtRegSystem.Posix.Directory.Foreign
    dtSockSystem.Posix.Directory.Foreign
    dtUnknownSystem.Posix.Directory.Foreign
    easyCopyHPath.IO
    easyDeleteHPath.IO
    equalFilePathSystem.Posix.FilePath
    executeFileHPath.IO
    extSeparatorSystem.Posix.FilePath
    FailEarlyHPath.IO
    fdOpendirSystem.Posix.Directory.Traversals
    FileTypeHPath.IO
    Flags 
    1 (Type/Class)System.Posix.Directory.Foreign
    2 (Data Constructor)System.Posix.Directory.Foreign
    FnHPath
    fromAbsHPath
    fromRelHPath
    getAllParentsHPath
    getDirectoryContentsSystem.Posix.Directory.Traversals
    getDirectoryContents'System.Posix.Directory.Traversals
    getDirsFilesHPath.IO
    getFileTypeHPath.IO
    getSearchPathSystem.Posix.FilePath
    handleIOErrorHPath.IO.Errors
    hasExtensionSystem.Posix.FilePath
    hasParentDirSystem.Posix.FilePath
    hasTrailingPathSeparatorSystem.Posix.FilePath
    hiddenFileSystem.Posix.FilePath
    HPathIOExceptionHPath.IO.Errors
    isAbsoluteSystem.Posix.FilePath
    isCopyFileFailedHPath.IO.Errors
    isCreateDirFailedHPath.IO.Errors
    isDestinationInSourceHPath.IO.Errors
    isExtSeparatorSystem.Posix.FilePath
    isFileNameSystem.Posix.FilePath
    isParentOfHPath
    isPathSeparatorSystem.Posix.FilePath
    isReadContentsFailedHPath.IO.Errors
    isRecreateSymlinkFailedHPath.IO.Errors
    isRecursiveFailureHPath.IO.Errors
    isRelativeSystem.Posix.FilePath
    isSameFileHPath.IO.Errors
    isSearchPathSeparatorSystem.Posix.FilePath
    isSupportedSystem.Posix.Directory.Foreign
    isValidSystem.Posix.FilePath
    isWritableHPath.IO.Errors
    joinPathSystem.Posix.FilePath
    makeRelativeSystem.Posix.FilePath
    makeValidSystem.Posix.FilePath
    moveFileHPath.IO
    NamedPipeHPath.IO
    newDirPermsHPath.IO
    newFilePermsHPath.IO
    normaliseSystem.Posix.FilePath
    oAppendSystem.Posix.Directory.Foreign
    oAsyncSystem.Posix.Directory.Foreign
    oCloexecSystem.Posix.Directory.Foreign
    oCreatSystem.Posix.Directory.Foreign
    oDirectorySystem.Posix.Directory.Foreign
    oExclSystem.Posix.Directory.Foreign
    oNocttySystem.Posix.Directory.Foreign
    oNofollowSystem.Posix.Directory.Foreign
    oNonblockSystem.Posix.Directory.Foreign
    openFdSystem.Posix.FD
    openFileHPath.IO
    oRdonlySystem.Posix.Directory.Foreign
    oRdwrSystem.Posix.Directory.Foreign
    oSyncSystem.Posix.Directory.Foreign
    oTruncSystem.Posix.Directory.Foreign
    OverwriteHPath.IO
    oWronlySystem.Posix.Directory.Foreign
    packDirStreamSystem.Posix.Directory.Traversals
    parseAbsHPath
    parseFnHPath
    parseRelHPath
    Path 
    1 (Type/Class)HPath
    2 (Data Constructor)HPath
    PathExceptionHPath
    pathMaxSystem.Posix.Directory.Foreign
    PathParseExceptionHPath
    pathSeparatorSystem.Posix.FilePath
    peekFilePathSystem.Posix.FilePath
    peekFilePathLenSystem.Posix.FilePath
    RawFilePathSystem.Posix.FilePath
    reactOnErrorHPath.IO.Errors
    ReadContentsFailedHPath.IO.Errors
    readDirEntSystem.Posix.Directory.Traversals
    realpathSystem.Posix.Directory.Traversals
    recreateSymlinkHPath.IO
    RecreateSymlinkFailedHPath.IO.Errors
    RecursiveErrorModeHPath.IO
    RecursiveFailureHPath.IO.Errors
    RecursiveFailureHintHPath.IO.Errors
    RegularFileHPath.IO
    RelHPath
    RelCHPath
    renameFileHPath.IO
    replaceBaseNameSystem.Posix.FilePath
    replaceDirectorySystem.Posix.FilePath
    replaceExtensionSystem.Posix.FilePath
    replaceFileNameSystem.Posix.FilePath
    rethrowErrnoAsHPath.IO.Errors
    SameFileHPath.IO.Errors
    sameFileHPath.IO.Errors
    searchPathSeparatorSystem.Posix.FilePath
    SocketHPath.IO
    splitDirectoriesSystem.Posix.FilePath
    splitExtensionSystem.Posix.FilePath
    splitExtensionsSystem.Posix.FilePath
    splitFileNameSystem.Posix.FilePath
    splitPathSystem.Posix.FilePath
    splitSearchPathSystem.Posix.FilePath
    StrictHPath.IO
    stripDirHPath
    stripExtensionSystem.Posix.FilePath
    SymbolicLinkHPath.IO
    takeBaseNameSystem.Posix.FilePath
    takeDirectorySystem.Posix.FilePath
    takeExtensionSystem.Posix.FilePath
    takeExtensionsSystem.Posix.FilePath
    takeFileNameSystem.Posix.FilePath
    throwDestinationInSourceHPath.IO.Errors
    throwDirDoesExistHPath.IO.Errors
    throwErrnoPathSystem.Posix.FilePath
    throwErrnoPathIfSystem.Posix.FilePath
    throwErrnoPathIfMinus1System.Posix.FilePath
    throwErrnoPathIfMinus1RetrySystem.Posix.FilePath
    throwErrnoPathIfMinus1Retry_System.Posix.FilePath
    throwErrnoPathIfMinus1_System.Posix.FilePath
    throwErrnoPathIfNullSystem.Posix.FilePath
    throwErrnoPathIfNullRetrySystem.Posix.FilePath
    throwErrnoPathIfRetrySystem.Posix.FilePath
    throwErrnoPathIf_System.Posix.FilePath
    throwFileDoesExistHPath.IO.Errors
    throwSameFileHPath.IO.Errors
    toFilePathHPath
    traverseDirectorySystem.Posix.Directory.Traversals
    unFlagsSystem.Posix.Directory.Foreign
    unionFlagsSystem.Posix.Directory.Foreign
    unpackDirStreamSystem.Posix.Directory.Traversals
    UnsupportedFlagSystem.Posix.Directory.Foreign
    withAbsPathHPath
    withFilePathSystem.Posix.FilePath
    withFnPathHPath
    withRelPathHPath
    \ No newline at end of file +

    hpath-0.8.0: Support for well-typed paths

    Index

    <.>System.Posix.FilePath
    </> 
    1 (Function)System.Posix.FilePath
    2 (Function)HPath
    AbsHPath
    addExtensionSystem.Posix.FilePath
    addTrailingPathSeparatorSystem.Posix.FilePath
    allDirectoryContentsSystem.Posix.Directory.Traversals
    allDirectoryContents'System.Posix.Directory.Traversals
    basenameHPath
    BlockDeviceHPath.IO
    bracketeerHPath.IO.Errors
    canonicalizePathHPath.IO
    canOpenDirectoryHPath.IO.Errors
    catchErrnoHPath.IO.Errors
    CharacterDeviceHPath.IO
    CollectFailuresHPath.IO
    combineSystem.Posix.FilePath
    copyDirRecursiveHPath.IO
    copyFileHPath.IO
    CopyFileFailedHPath.IO.Errors
    CopyModeHPath.IO
    createDirHPath.IO
    CreateDirFailedHPath.IO.Errors
    createDirRecursiveHPath.IO
    createRegularFileHPath.IO
    createSymlinkHPath.IO
    deleteDirHPath.IO
    deleteDirRecursiveHPath.IO
    deleteFileHPath.IO
    DestinationInSourceHPath.IO.Errors
    DirectoryHPath.IO
    dirnameHPath
    DirType 
    1 (Type/Class)System.Posix.Directory.Foreign
    2 (Data Constructor)System.Posix.Directory.Foreign
    doesDirectoryExistHPath.IO.Errors
    doesFileExistHPath.IO.Errors
    dropExtensionSystem.Posix.FilePath
    dropExtensionsSystem.Posix.FilePath
    dropFileNameSystem.Posix.FilePath
    dropTrailingPathSeparatorSystem.Posix.FilePath
    dtBlkSystem.Posix.Directory.Foreign
    dtChrSystem.Posix.Directory.Foreign
    dtDirSystem.Posix.Directory.Foreign
    dtFifoSystem.Posix.Directory.Foreign
    dtLnkSystem.Posix.Directory.Foreign
    dtRegSystem.Posix.Directory.Foreign
    dtSockSystem.Posix.Directory.Foreign
    dtUnknownSystem.Posix.Directory.Foreign
    easyCopyHPath.IO
    easyDeleteHPath.IO
    equalFilePathSystem.Posix.FilePath
    executeFileHPath.IO
    extSeparatorSystem.Posix.FilePath
    FailEarlyHPath.IO
    fdOpendirSystem.Posix.Directory.Traversals
    FileTypeHPath.IO
    Flags 
    1 (Type/Class)System.Posix.Directory.Foreign
    2 (Data Constructor)System.Posix.Directory.Foreign
    FnHPath
    fromAbsHPath
    fromRelHPath
    getAllParentsHPath
    getDirectoryContentsSystem.Posix.Directory.Traversals
    getDirectoryContents'System.Posix.Directory.Traversals
    getDirsFilesHPath.IO
    getFileTypeHPath.IO
    getSearchPathSystem.Posix.FilePath
    handleIOErrorHPath.IO.Errors
    hasExtensionSystem.Posix.FilePath
    hasParentDirSystem.Posix.FilePath
    hasTrailingPathSeparatorSystem.Posix.FilePath
    hiddenFileSystem.Posix.FilePath
    HPathIOExceptionHPath.IO.Errors
    isAbsoluteSystem.Posix.FilePath
    isCopyFileFailedHPath.IO.Errors
    isCreateDirFailedHPath.IO.Errors
    isDestinationInSourceHPath.IO.Errors
    isExtSeparatorSystem.Posix.FilePath
    isFileNameSystem.Posix.FilePath
    isParentOfHPath
    isPathSeparatorSystem.Posix.FilePath
    isReadContentsFailedHPath.IO.Errors
    isRecreateSymlinkFailedHPath.IO.Errors
    isRecursiveFailureHPath.IO.Errors
    isRelativeSystem.Posix.FilePath
    isSameFileHPath.IO.Errors
    isSearchPathSeparatorSystem.Posix.FilePath
    isSupportedSystem.Posix.Directory.Foreign
    isValidSystem.Posix.FilePath
    isWritableHPath.IO.Errors
    joinPathSystem.Posix.FilePath
    makeRelativeSystem.Posix.FilePath
    makeValidSystem.Posix.FilePath
    moveFileHPath.IO
    NamedPipeHPath.IO
    newDirPermsHPath.IO
    newFilePermsHPath.IO
    normaliseSystem.Posix.FilePath
    oAppendSystem.Posix.Directory.Foreign
    oAsyncSystem.Posix.Directory.Foreign
    oCloexecSystem.Posix.Directory.Foreign
    oCreatSystem.Posix.Directory.Foreign
    oDirectorySystem.Posix.Directory.Foreign
    oExclSystem.Posix.Directory.Foreign
    oNocttySystem.Posix.Directory.Foreign
    oNofollowSystem.Posix.Directory.Foreign
    oNonblockSystem.Posix.Directory.Foreign
    openFdSystem.Posix.FD
    openFileHPath.IO
    oRdonlySystem.Posix.Directory.Foreign
    oRdwrSystem.Posix.Directory.Foreign
    oSyncSystem.Posix.Directory.Foreign
    oTruncSystem.Posix.Directory.Foreign
    OverwriteHPath.IO
    oWronlySystem.Posix.Directory.Foreign
    packDirStreamSystem.Posix.Directory.Traversals
    parseAbsHPath
    parseFnHPath
    parseRelHPath
    Path 
    1 (Type/Class)HPath
    2 (Data Constructor)HPath
    PathExceptionHPath
    pathMaxSystem.Posix.Directory.Foreign
    PathParseExceptionHPath
    pathSeparatorSystem.Posix.FilePath
    peekFilePathSystem.Posix.FilePath
    peekFilePathLenSystem.Posix.FilePath
    RawFilePathSystem.Posix.FilePath
    reactOnErrorHPath.IO.Errors
    ReadContentsFailedHPath.IO.Errors
    readDirEntSystem.Posix.Directory.Traversals
    realpathSystem.Posix.Directory.Traversals
    recreateSymlinkHPath.IO
    RecreateSymlinkFailedHPath.IO.Errors
    RecursiveErrorModeHPath.IO
    RecursiveFailureHPath.IO.Errors
    RecursiveFailureHintHPath.IO.Errors
    RegularFileHPath.IO
    RelHPath
    RelCHPath
    renameFileHPath.IO
    replaceBaseNameSystem.Posix.FilePath
    replaceDirectorySystem.Posix.FilePath
    replaceExtensionSystem.Posix.FilePath
    replaceFileNameSystem.Posix.FilePath
    rethrowErrnoAsHPath.IO.Errors
    SameFileHPath.IO.Errors
    sameFileHPath.IO.Errors
    searchPathSeparatorSystem.Posix.FilePath
    SocketHPath.IO
    splitDirectoriesSystem.Posix.FilePath
    splitExtensionSystem.Posix.FilePath
    splitExtensionsSystem.Posix.FilePath
    splitFileNameSystem.Posix.FilePath
    splitPathSystem.Posix.FilePath
    splitSearchPathSystem.Posix.FilePath
    StrictHPath.IO
    stripDirHPath
    stripExtensionSystem.Posix.FilePath
    SymbolicLinkHPath.IO
    takeBaseNameSystem.Posix.FilePath
    takeDirectorySystem.Posix.FilePath
    takeExtensionSystem.Posix.FilePath
    takeExtensionsSystem.Posix.FilePath
    takeFileNameSystem.Posix.FilePath
    throwDestinationInSourceHPath.IO.Errors
    throwDirDoesExistHPath.IO.Errors
    throwErrnoPathSystem.Posix.FilePath
    throwErrnoPathIfSystem.Posix.FilePath
    throwErrnoPathIfMinus1System.Posix.FilePath
    throwErrnoPathIfMinus1RetrySystem.Posix.FilePath
    throwErrnoPathIfMinus1Retry_System.Posix.FilePath
    throwErrnoPathIfMinus1_System.Posix.FilePath
    throwErrnoPathIfNullSystem.Posix.FilePath
    throwErrnoPathIfNullRetrySystem.Posix.FilePath
    throwErrnoPathIfRetrySystem.Posix.FilePath
    throwErrnoPathIf_System.Posix.FilePath
    throwFileDoesExistHPath.IO.Errors
    throwSameFileHPath.IO.Errors
    toFilePathHPath
    traverseDirectorySystem.Posix.Directory.Traversals
    unFlagsSystem.Posix.Directory.Foreign
    unionFlagsSystem.Posix.Directory.Foreign
    unpackDirStreamSystem.Posix.Directory.Traversals
    UnsupportedFlagSystem.Posix.Directory.Foreign
    withAbsPathHPath
    withFilePathSystem.Posix.FilePath
    withFnPathHPath
    withRelPathHPath
    \ No newline at end of file diff --git a/doc-index-B.html b/doc-index-B.html index 4118213..53632d1 100644 --- a/doc-index-B.html +++ b/doc-index-B.html @@ -1,4 +1,4 @@ -hpath-0.8.0: Support for well-typed paths (Index - B)

    hpath-0.8.0: Support for well-typed paths

    Index - B

    basenameHPath
    BlockDeviceHPath.IO
    bracketeerHPath.IO.Errors
    \ No newline at end of file +

    hpath-0.8.0: Support for well-typed paths

    Index - B

    basenameHPath
    BlockDeviceHPath.IO
    bracketeerHPath.IO.Errors
    \ No newline at end of file diff --git a/doc-index-C.html b/doc-index-C.html index ac12913..88bac9d 100644 --- a/doc-index-C.html +++ b/doc-index-C.html @@ -1,4 +1,4 @@ -hpath-0.8.0: Support for well-typed paths (Index - C)

    hpath-0.8.0: Support for well-typed paths

    Index - C

    canonicalizePathHPath.IO
    canOpenDirectoryHPath.IO.Errors
    catchErrnoHPath.IO.Errors
    CharacterDeviceHPath.IO
    CollectFailuresHPath.IO
    combineSystem.Posix.FilePath
    copyDirRecursiveHPath.IO
    copyFileHPath.IO
    CopyFileFailedHPath.IO.Errors
    CopyModeHPath.IO
    createDirHPath.IO
    CreateDirFailedHPath.IO.Errors
    createDirRecursiveHPath.IO
    createRegularFileHPath.IO
    createSymlinkHPath.IO
    \ No newline at end of file +

    hpath-0.8.0: Support for well-typed paths

    Index - C

    canonicalizePathHPath.IO
    canOpenDirectoryHPath.IO.Errors
    catchErrnoHPath.IO.Errors
    CharacterDeviceHPath.IO
    CollectFailuresHPath.IO
    combineSystem.Posix.FilePath
    copyDirRecursiveHPath.IO
    copyFileHPath.IO
    CopyFileFailedHPath.IO.Errors
    CopyModeHPath.IO
    createDirHPath.IO
    CreateDirFailedHPath.IO.Errors
    createDirRecursiveHPath.IO
    createRegularFileHPath.IO
    createSymlinkHPath.IO
    \ No newline at end of file diff --git a/doc-index-D.html b/doc-index-D.html index c48378c..6ce8c18 100644 --- a/doc-index-D.html +++ b/doc-index-D.html @@ -1,4 +1,4 @@ -hpath-0.8.0: Support for well-typed paths (Index - D)

    hpath-0.8.0: Support for well-typed paths

    \ No newline at end of file +

    hpath-0.8.0: Support for well-typed paths

    \ No newline at end of file diff --git a/doc-index-E.html b/doc-index-E.html index ee70b6d..5be3bdb 100644 --- a/doc-index-E.html +++ b/doc-index-E.html @@ -1,4 +1,4 @@ -hpath-0.8.0: Support for well-typed paths (Index - E)

    hpath-0.8.0: Support for well-typed paths

    Index - E

    easyCopyHPath.IO
    easyDeleteHPath.IO
    equalFilePathSystem.Posix.FilePath
    executeFileHPath.IO
    extSeparatorSystem.Posix.FilePath
    \ No newline at end of file +

    hpath-0.8.0: Support for well-typed paths

    Index - E

    easyCopyHPath.IO
    easyDeleteHPath.IO
    equalFilePathSystem.Posix.FilePath
    executeFileHPath.IO
    extSeparatorSystem.Posix.FilePath
    \ No newline at end of file diff --git a/doc-index-F.html b/doc-index-F.html index adcdaf5..03860ba 100644 --- a/doc-index-F.html +++ b/doc-index-F.html @@ -1,4 +1,4 @@ -hpath-0.8.0: Support for well-typed paths (Index - F)

    hpath-0.8.0: Support for well-typed paths

    Index - F

    FailEarlyHPath.IO
    fdOpendirSystem.Posix.Directory.Traversals
    FileTypeHPath.IO
    Flags 
    1 (Type/Class)System.Posix.Directory.Foreign
    2 (Data Constructor)System.Posix.Directory.Foreign
    FnHPath
    fromAbsHPath
    fromRelHPath
    \ No newline at end of file +

    hpath-0.8.0: Support for well-typed paths

    Index - F

    FailEarlyHPath.IO
    fdOpendirSystem.Posix.Directory.Traversals
    FileTypeHPath.IO
    Flags 
    1 (Type/Class)System.Posix.Directory.Foreign
    2 (Data Constructor)System.Posix.Directory.Foreign
    FnHPath
    fromAbsHPath
    fromRelHPath
    \ No newline at end of file diff --git a/doc-index-G.html b/doc-index-G.html index 95139ca..b6b911d 100644 --- a/doc-index-G.html +++ b/doc-index-G.html @@ -1,4 +1,4 @@ -hpath-0.8.0: Support for well-typed paths (Index - G)

    hpath-0.8.0: Support for well-typed paths

    Index - G

    getAllParentsHPath
    getDirectoryContentsSystem.Posix.Directory.Traversals
    getDirectoryContents'System.Posix.Directory.Traversals
    getDirsFilesHPath.IO
    getFileTypeHPath.IO
    getSearchPathSystem.Posix.FilePath
    \ No newline at end of file +

    hpath-0.8.0: Support for well-typed paths

    Index - G

    getAllParentsHPath
    getDirectoryContentsSystem.Posix.Directory.Traversals
    getDirectoryContents'System.Posix.Directory.Traversals
    getDirsFilesHPath.IO
    getFileTypeHPath.IO
    getSearchPathSystem.Posix.FilePath
    \ No newline at end of file diff --git a/doc-index-H.html b/doc-index-H.html index bcd29dd..953b703 100644 --- a/doc-index-H.html +++ b/doc-index-H.html @@ -1,4 +1,4 @@ -hpath-0.8.0: Support for well-typed paths (Index - H)

    hpath-0.8.0: Support for well-typed paths

    Index - H

    handleIOErrorHPath.IO.Errors
    hasExtensionSystem.Posix.FilePath
    hasParentDirSystem.Posix.FilePath
    hasTrailingPathSeparatorSystem.Posix.FilePath
    hiddenFileSystem.Posix.FilePath
    HPathIOExceptionHPath.IO.Errors
    \ No newline at end of file +

    hpath-0.8.0: Support for well-typed paths

    Index - H

    handleIOErrorHPath.IO.Errors
    hasExtensionSystem.Posix.FilePath
    hasParentDirSystem.Posix.FilePath
    hasTrailingPathSeparatorSystem.Posix.FilePath
    hiddenFileSystem.Posix.FilePath
    HPathIOExceptionHPath.IO.Errors
    \ No newline at end of file diff --git a/doc-index-I.html b/doc-index-I.html index 747c758..d336a44 100644 --- a/doc-index-I.html +++ b/doc-index-I.html @@ -1,4 +1,4 @@ -hpath-0.8.0: Support for well-typed paths (Index - I)

    hpath-0.8.0: Support for well-typed paths

    Index - I

    isAbsoluteSystem.Posix.FilePath
    isCopyFileFailedHPath.IO.Errors
    isCreateDirFailedHPath.IO.Errors
    isDestinationInSourceHPath.IO.Errors
    isExtSeparatorSystem.Posix.FilePath
    isFileNameSystem.Posix.FilePath
    isParentOfHPath
    isPathSeparatorSystem.Posix.FilePath
    isReadContentsFailedHPath.IO.Errors
    isRecreateSymlinkFailedHPath.IO.Errors
    isRecursiveFailureHPath.IO.Errors
    isRelativeSystem.Posix.FilePath
    isSameFileHPath.IO.Errors
    isSearchPathSeparatorSystem.Posix.FilePath
    isSupportedSystem.Posix.Directory.Foreign
    isValidSystem.Posix.FilePath
    isWritableHPath.IO.Errors
    \ No newline at end of file +

    hpath-0.8.0: Support for well-typed paths

    Index - I

    isAbsoluteSystem.Posix.FilePath
    isCopyFileFailedHPath.IO.Errors
    isCreateDirFailedHPath.IO.Errors
    isDestinationInSourceHPath.IO.Errors
    isExtSeparatorSystem.Posix.FilePath
    isFileNameSystem.Posix.FilePath
    isParentOfHPath
    isPathSeparatorSystem.Posix.FilePath
    isReadContentsFailedHPath.IO.Errors
    isRecreateSymlinkFailedHPath.IO.Errors
    isRecursiveFailureHPath.IO.Errors
    isRelativeSystem.Posix.FilePath
    isSameFileHPath.IO.Errors
    isSearchPathSeparatorSystem.Posix.FilePath
    isSupportedSystem.Posix.Directory.Foreign
    isValidSystem.Posix.FilePath
    isWritableHPath.IO.Errors
    \ No newline at end of file diff --git a/doc-index-J.html b/doc-index-J.html index afa8e68..5ef1f92 100644 --- a/doc-index-J.html +++ b/doc-index-J.html @@ -1,4 +1,4 @@ -hpath-0.8.0: Support for well-typed paths (Index - J)

    hpath-0.8.0: Support for well-typed paths

    Index - J

    joinPathSystem.Posix.FilePath
    \ No newline at end of file +

    hpath-0.8.0: Support for well-typed paths

    Index - J

    joinPathSystem.Posix.FilePath
    \ No newline at end of file diff --git a/doc-index-M.html b/doc-index-M.html index 5fe1e15..d9a7b58 100644 --- a/doc-index-M.html +++ b/doc-index-M.html @@ -1,4 +1,4 @@ -hpath-0.8.0: Support for well-typed paths (Index - M)

    hpath-0.8.0: Support for well-typed paths

    Index - M

    makeRelativeSystem.Posix.FilePath
    makeValidSystem.Posix.FilePath
    moveFileHPath.IO
    \ No newline at end of file +

    hpath-0.8.0: Support for well-typed paths

    Index - M

    makeRelativeSystem.Posix.FilePath
    makeValidSystem.Posix.FilePath
    moveFileHPath.IO
    \ No newline at end of file diff --git a/doc-index-N.html b/doc-index-N.html index 8372785..c02effe 100644 --- a/doc-index-N.html +++ b/doc-index-N.html @@ -1,4 +1,4 @@ -hpath-0.8.0: Support for well-typed paths (Index - N)

    hpath-0.8.0: Support for well-typed paths

    Index - N

    NamedPipeHPath.IO
    newDirPermsHPath.IO
    newFilePermsHPath.IO
    normaliseSystem.Posix.FilePath
    \ No newline at end of file +

    hpath-0.8.0: Support for well-typed paths

    Index - N

    NamedPipeHPath.IO
    newDirPermsHPath.IO
    newFilePermsHPath.IO
    normaliseSystem.Posix.FilePath
    \ No newline at end of file diff --git a/doc-index-O.html b/doc-index-O.html index 51b7632..03003dc 100644 --- a/doc-index-O.html +++ b/doc-index-O.html @@ -1,4 +1,4 @@ -hpath-0.8.0: Support for well-typed paths (Index - O)

    hpath-0.8.0: Support for well-typed paths

    \ No newline at end of file +

    hpath-0.8.0: Support for well-typed paths

    \ No newline at end of file diff --git a/doc-index-P.html b/doc-index-P.html index 0b6ebd2..9a11556 100644 --- a/doc-index-P.html +++ b/doc-index-P.html @@ -1,4 +1,4 @@ -hpath-0.8.0: Support for well-typed paths (Index - P)

    hpath-0.8.0: Support for well-typed paths

    Index - P

    packDirStreamSystem.Posix.Directory.Traversals
    parseAbsHPath
    parseFnHPath
    parseRelHPath
    Path 
    1 (Type/Class)HPath
    2 (Data Constructor)HPath
    PathExceptionHPath
    pathMaxSystem.Posix.Directory.Foreign
    PathParseExceptionHPath
    pathSeparatorSystem.Posix.FilePath
    peekFilePathSystem.Posix.FilePath
    peekFilePathLenSystem.Posix.FilePath
    \ No newline at end of file +

    hpath-0.8.0: Support for well-typed paths

    Index - P

    packDirStreamSystem.Posix.Directory.Traversals
    parseAbsHPath
    parseFnHPath
    parseRelHPath
    Path 
    1 (Type/Class)HPath
    2 (Data Constructor)HPath
    PathExceptionHPath
    pathMaxSystem.Posix.Directory.Foreign
    PathParseExceptionHPath
    pathSeparatorSystem.Posix.FilePath
    peekFilePathSystem.Posix.FilePath
    peekFilePathLenSystem.Posix.FilePath
    \ No newline at end of file diff --git a/doc-index-R.html b/doc-index-R.html index d71b482..3ac9874 100644 --- a/doc-index-R.html +++ b/doc-index-R.html @@ -1,4 +1,4 @@ -hpath-0.8.0: Support for well-typed paths (Index - R)

    hpath-0.8.0: Support for well-typed paths

    Index - R

    RawFilePathSystem.Posix.FilePath
    reactOnErrorHPath.IO.Errors
    ReadContentsFailedHPath.IO.Errors
    readDirEntSystem.Posix.Directory.Traversals
    realpathSystem.Posix.Directory.Traversals
    recreateSymlinkHPath.IO
    RecreateSymlinkFailedHPath.IO.Errors
    RecursiveErrorModeHPath.IO
    RecursiveFailureHPath.IO.Errors
    RecursiveFailureHintHPath.IO.Errors
    RegularFileHPath.IO
    RelHPath
    RelCHPath
    renameFileHPath.IO
    replaceBaseNameSystem.Posix.FilePath
    replaceDirectorySystem.Posix.FilePath
    replaceExtensionSystem.Posix.FilePath
    replaceFileNameSystem.Posix.FilePath
    rethrowErrnoAsHPath.IO.Errors
    \ No newline at end of file +

    hpath-0.8.0: Support for well-typed paths

    Index - R

    RawFilePathSystem.Posix.FilePath
    reactOnErrorHPath.IO.Errors
    ReadContentsFailedHPath.IO.Errors
    readDirEntSystem.Posix.Directory.Traversals
    realpathSystem.Posix.Directory.Traversals
    recreateSymlinkHPath.IO
    RecreateSymlinkFailedHPath.IO.Errors
    RecursiveErrorModeHPath.IO
    RecursiveFailureHPath.IO.Errors
    RecursiveFailureHintHPath.IO.Errors
    RegularFileHPath.IO
    RelHPath
    RelCHPath
    renameFileHPath.IO
    replaceBaseNameSystem.Posix.FilePath
    replaceDirectorySystem.Posix.FilePath
    replaceExtensionSystem.Posix.FilePath
    replaceFileNameSystem.Posix.FilePath
    rethrowErrnoAsHPath.IO.Errors
    \ No newline at end of file diff --git a/doc-index-S.html b/doc-index-S.html index 8059603..543a716 100644 --- a/doc-index-S.html +++ b/doc-index-S.html @@ -1,4 +1,4 @@ -hpath-0.8.0: Support for well-typed paths (Index - S)

    hpath-0.8.0: Support for well-typed paths

    Index - S

    SameFileHPath.IO.Errors
    sameFileHPath.IO.Errors
    searchPathSeparatorSystem.Posix.FilePath
    SocketHPath.IO
    splitDirectoriesSystem.Posix.FilePath
    splitExtensionSystem.Posix.FilePath
    splitExtensionsSystem.Posix.FilePath
    splitFileNameSystem.Posix.FilePath
    splitPathSystem.Posix.FilePath
    splitSearchPathSystem.Posix.FilePath
    StrictHPath.IO
    stripDirHPath
    stripExtensionSystem.Posix.FilePath
    SymbolicLinkHPath.IO
    \ No newline at end of file +

    hpath-0.8.0: Support for well-typed paths

    Index - S

    SameFileHPath.IO.Errors
    sameFileHPath.IO.Errors
    searchPathSeparatorSystem.Posix.FilePath
    SocketHPath.IO
    splitDirectoriesSystem.Posix.FilePath
    splitExtensionSystem.Posix.FilePath
    splitExtensionsSystem.Posix.FilePath
    splitFileNameSystem.Posix.FilePath
    splitPathSystem.Posix.FilePath
    splitSearchPathSystem.Posix.FilePath
    StrictHPath.IO
    stripDirHPath
    stripExtensionSystem.Posix.FilePath
    SymbolicLinkHPath.IO
    \ No newline at end of file diff --git a/doc-index-T.html b/doc-index-T.html index e5d67d1..5b02aa9 100644 --- a/doc-index-T.html +++ b/doc-index-T.html @@ -1,4 +1,4 @@ -hpath-0.8.0: Support for well-typed paths (Index - T)

    hpath-0.8.0: Support for well-typed paths

    Index - T

    takeBaseNameSystem.Posix.FilePath
    takeDirectorySystem.Posix.FilePath
    takeExtensionSystem.Posix.FilePath
    takeExtensionsSystem.Posix.FilePath
    takeFileNameSystem.Posix.FilePath
    throwDestinationInSourceHPath.IO.Errors
    throwDirDoesExistHPath.IO.Errors
    throwErrnoPathSystem.Posix.FilePath
    throwErrnoPathIfSystem.Posix.FilePath
    throwErrnoPathIfMinus1System.Posix.FilePath
    throwErrnoPathIfMinus1RetrySystem.Posix.FilePath
    throwErrnoPathIfMinus1Retry_System.Posix.FilePath
    throwErrnoPathIfMinus1_System.Posix.FilePath
    throwErrnoPathIfNullSystem.Posix.FilePath
    throwErrnoPathIfNullRetrySystem.Posix.FilePath
    throwErrnoPathIfRetrySystem.Posix.FilePath
    throwErrnoPathIf_System.Posix.FilePath
    throwFileDoesExistHPath.IO.Errors
    throwSameFileHPath.IO.Errors
    toFilePathHPath
    traverseDirectorySystem.Posix.Directory.Traversals
    \ No newline at end of file +

    hpath-0.8.0: Support for well-typed paths

    Index - T

    takeBaseNameSystem.Posix.FilePath
    takeDirectorySystem.Posix.FilePath
    takeExtensionSystem.Posix.FilePath
    takeExtensionsSystem.Posix.FilePath
    takeFileNameSystem.Posix.FilePath
    throwDestinationInSourceHPath.IO.Errors
    throwDirDoesExistHPath.IO.Errors
    throwErrnoPathSystem.Posix.FilePath
    throwErrnoPathIfSystem.Posix.FilePath
    throwErrnoPathIfMinus1System.Posix.FilePath
    throwErrnoPathIfMinus1RetrySystem.Posix.FilePath
    throwErrnoPathIfMinus1Retry_System.Posix.FilePath
    throwErrnoPathIfMinus1_System.Posix.FilePath
    throwErrnoPathIfNullSystem.Posix.FilePath
    throwErrnoPathIfNullRetrySystem.Posix.FilePath
    throwErrnoPathIfRetrySystem.Posix.FilePath
    throwErrnoPathIf_System.Posix.FilePath
    throwFileDoesExistHPath.IO.Errors
    throwSameFileHPath.IO.Errors
    toFilePathHPath
    traverseDirectorySystem.Posix.Directory.Traversals
    \ No newline at end of file diff --git a/doc-index-U.html b/doc-index-U.html index 07f0fd8..8bea867 100644 --- a/doc-index-U.html +++ b/doc-index-U.html @@ -1,4 +1,4 @@ -hpath-0.8.0: Support for well-typed paths (Index - U)

    hpath-0.8.0: Support for well-typed paths

    \ No newline at end of file +

    hpath-0.8.0: Support for well-typed paths

    \ No newline at end of file diff --git a/doc-index-W.html b/doc-index-W.html index be9d0b3..1d711b8 100644 --- a/doc-index-W.html +++ b/doc-index-W.html @@ -1,4 +1,4 @@ -hpath-0.8.0: Support for well-typed paths (Index - W)

    hpath-0.8.0: Support for well-typed paths

    Index - W

    withAbsPathHPath
    withFilePathSystem.Posix.FilePath
    withFnPathHPath
    withRelPathHPath
    \ No newline at end of file +

    hpath-0.8.0: Support for well-typed paths

    Index - W

    withAbsPathHPath
    withFilePathSystem.Posix.FilePath
    withFnPathHPath
    withRelPathHPath
    \ No newline at end of file diff --git a/doc-index.html b/doc-index.html index 02109de..f3869df 100644 --- a/doc-index.html +++ b/doc-index.html @@ -1,4 +1,4 @@ -hpath-0.8.0: Support for well-typed paths (Index)

    hpath-0.8.0: Support for well-typed paths

    \ No newline at end of file +

    hpath-0.8.0: Support for well-typed paths

    \ No newline at end of file diff --git a/frames.html b/frames.html index e86edb6..1b4e38d 100644 --- a/frames.html +++ b/frames.html @@ -1,4 +1,4 @@ - diff --git a/haddock-util.js b/haddock-util.js index fc7743f..9a6fccf 100644 --- a/haddock-util.js +++ b/haddock-util.js @@ -131,11 +131,11 @@ function perform_search(full) var text = document.getElementById("searchbox").value.toLowerCase(); if (text == last_search && !full) return; last_search = text; - + var table = document.getElementById("indexlist"); var status = document.getElementById("searchmsg"); var children = table.firstChild.childNodes; - + // first figure out the first node with the prefix var first = bisect(-1); var last = (first == -1 ? -1 : bisect(1)); @@ -166,7 +166,7 @@ function perform_search(full) status.innerHTML = ""; } - + function setclass(first, last, status) { for (var i = first; i <= last; i++) @@ -174,8 +174,8 @@ function perform_search(full) children[i].className = status; } } - - + + // do a binary search, treating 0 as ... // return either -1 (no 0's found) or location of most far match function bisect(dir) @@ -201,9 +201,9 @@ function perform_search(full) if (checkitem(i) == 0) return i; } return -1; - } - - + } + + // from an index, decide what the result is // 0 = match, -1 is lower, 1 is higher function checkitem(i) @@ -212,8 +212,8 @@ function perform_search(full) if (s == text) return 0; else return (s > text ? -1 : 1); } - - + + // from an index, get its string // this abstracts over alternates function getitem(i) @@ -229,7 +229,7 @@ function perform_search(full) } function setSynopsis(filename) { - if (parent.window.synopsis && parent.window.synopsis.location) { + if (parent.window.synopsis) { if (parent.window.synopsis.location.replace) { // In Firefox this avoids adding the change to the history. parent.window.synopsis.location.replace(filename); @@ -250,7 +250,7 @@ function addMenuItem(html) { function adjustForFrames() { var bodyCls; - + if (parent.location.href == window.location.href) { // not in frames, so add Frames button addMenuItem("Frames"); diff --git a/hpath.haddock b/hpath.haddock index 886f0bf4824ff876140e7c706a5c2a8e2727da7d..c1afafbc2bb54a4bdfa4d8ea558f375249036649 100644 GIT binary patch delta 7457 zcmb_g30M_ZvhKh8E+|AmFd!H%2oV$%P#pJw3dRHx6yt&mxZ)DQHJX?aT(cQLk9t&4 z^np z-(`~**yM#a`EE@UC!AN64Xb^6wx`M_SKH(@HhHa07B+dEOa@W^l71&09qIR0BYQ$1Dr$>j*r^xU91R>E_KCeF!T;0eQBx~>&X^rABTvN_6|`pDNZD`sdu*3484_Dln^a$938G| z8V)45;<;10zmt3<8xB!<&LLJNgfz9|5q`euB_xOwF{Q4Xxkm=~Fvogs2il2!u@Y^~ zthg!%5=Fz!{fv4&QZDI>Fp>F1fJkdM5J{paCz;goB6C!{C|Md}zTd9MaJQ$SpnK%Z zZAcc49q(||2OE*%#LzI2m)v{pK!>H2+roEYR0HG(J~HKl7J~mvrK+4!#jWCGDBI=Dv?|5MYa(b}L%0hQ!28hh zI1lHU(VGf^JhOarwT{70Y+V+7M zCT`tPhCBGIj6yv|tO@qWfEsfC$_S^pbTm+uEDx8zv?LGjvU5Hh!=QH-^*=_47j_+C zkS#(VjgT@8;qu!MV(dib@!dnwd^qnjr^-2^x@Uw)Y8Ng(*qgR}6(u zW_FUF;l%%c43GNPmW!(WT>_IiDn{`3MT@hqMTmgMg3K%X zS2zOCkPdnP)fUR_*_3rf-7k3EtUg!{G(1t?9oZwOPCLu&4Q6MUz0Ryb(}{ESSq&P$ z;zvM%-?lXGed6zEkxaE*ib9x)#ZOjYv}kd7df<~fcjTAR7_scI#8?r1Bp1bE%h8eI z*pas#MZxYA(YGPOJY;?AM2WfO=uiVi=9S~!-577SKN$?iIp|LEn{ZL^Numk71H1e&ZQTHlxp74ZsvL^uv+OP-;&9+yJ4nFQS~Tsk}!~ zB6d@}*tjZE&RRka=xI;y27d2c{pL8P#>)qRQRcz#^Nc>RWV^cTs9VmP zgfw->d5fjDnZ3j8U1p=1jbS#H**Hxs_+hZKT^&@xT5iiV z+>uA%;kgC397j}4G@hu0Xd=-hq6tKkiKY{AIxHocN;HLN2GN~FGwEXJx1CRcZ7*VP zVbj_2ci1R4{9oFQkIb)rn2H#K8gXgmeQ5sk9vn=Ha5CAxp%R#u&#!=t2B`^N4$cgTy1> zJDPdZ{Cs+~ai8`@ly1&9W;mBpq8i7U`EVwN!MTj!If4-uon3dsxt#D&#*%P=73f3? zoGVB<__}hm3vJ+BNy-$zGD)_{WuKrtHl`K<^1K@bxX(%pz%}50E44Wu((!=xOc2U- zJSdZc5#v6uwM@sPLTg1(e1#Oz}c)|Fs<4{_>;_|UsZr!8Q1k=a5` zejJK47dO?G$=sIsS&olJD{FKZl4veT&jR^oD;#n?$W0!y9=s7Jb*z$wt#Kjw6D@|6 zqInWq3L3q$Agv0%$x9;@u}XCPPU7fwcH`c#$Xvfl^0_$&G|5$%Un@k z7be|pkzlR#U?Z?vdg3qxRq~-YFgtkGA9z7Y|ktrpzzP+xv;rdmC_l)=3Td__q>4aFLN`GBecxbBFEV^zz`(}_l)RBBDX=TFN zzdEeoRP=Hf%k($J#hfs!qzk4Pv<30<;yR3wvE9%MpUFdoXeGxDqrI3fTV&(i(0MA4 zwl~y`=Pu}-R4f$FLz+C^l>#DUk3;6`h!xXY1j(^Ia0}+iEw`XM*2wDKm@519gxfpr zM&omxT$Lxg(hI$1?0B@1RlVRgzR=T~^xLqOJCB*=EKt6oAgN928#2|(Q?#KOeYVf4XSi}3O(Xi%NCVO z9kQknHw0|<9;Q0%jo!2Io%!c7I2-A|vsICNTCsB39ke6=Zkx_;z-Ia62u#FRGIAtk z$F0`PkvM1=HF}7c9T6^z%aQ8drnbc+n@>Wn%yc4zKCP^iW6&Su3iRz15iUG|Zh4^u zS#sJqB$Jm$HwEgMap+}yM$PE6r0HWoRBmy|oBC5yuP88NP5Wcz3mUt zSV!ZvQHQ5q1MK;9oKe>`$Uk9@*f)Qwes(VY0&oP%h}se zD)0OwJ}|!2d#SzSsFcl`Axyrt7?WK4I7NoatU2`2R@;xfXYO3YHAjHqcR#j)Qd z6h{^K)FN|+A#lHPkTNoBs64TWULA+%H-I&5DYnA+nwLuMerhenMp!t)t(@iflkW3; z|02C1ZG5BmMR%eK+uppVYjM75yYzp9KIqa&lQ6R2Z4tXIP zF1IfY%8C)_>g4_URxXw}i$|>vtI*c)#%I1&TZKe8w)!rPE|oNQ$cxqFEBoc`YcQ+T z@8$I7@O}l$%2g#%?{9eFp1WhE&C==K6P)xay)LW+Jx5p;`mhvQEYj(;9m0KBpJ5_6Xl~@ zks>>8MFgo5n^c)}LMn$->`g_THFX=-;5PwIjmo#94rTJeX!Hu%NJe=7Vr^!rhVLqw za^DVohg!K|Cl0jO!Y@j1G4wzg$NO2n3uEw|JiQC|%ak3Yn7bQeLUwbjJ|4z!eq_u$UJ$5?xS+2b;0FM7M{w0Ht#vM~zn!!%72V0$(Zu{AZad@ly|;WmP3 z9npHC4Me|gT1~n&L~Ds2CR$BYMWlwvA6}-Zy9p_@hj}^v>S_l5euBTE|J@`tRIk-C z+rsQSnY06a`PQY`R>rW7nJSm8?)$MBUDY18_bEAv`Tik#|KK*=y;Tk8H!gKn|)yJ6TbOD7mK&sp^-lx=?asH`}G|%nU$G-JShl zAqiYm&D~zv3-0j)9$=9l@BsJP!5{5lF$4PK*Z6#uz)uA#S)!uA60ht9OYLBp9W1wl z6?U-F4(_vq`!#v)Al6s7*lcz&E-p5k9h!>*?AcsYGj?$qdQO#7?GT_ma zhx&o?R6kH2%bTFuZ6$$=0^7W@7d&DI+x>u_JM3Vm9qh6Ll>|uPVx>w3ez4cS_o`|i z*HckozgPBxN9{mGmcN;-Sx!P|E5jtx|J|ErKjjqskYif?q<`*!ew9en5qd@3LL0Y5(`Qs>3sJTodzZgzns zDhgcm%9^u+t3L4~2A|r&XMVuX&+Xs~JNVKL{$dAT5ny}1<~{w!2fn4J_MHN>|CbnD zW=6%$>`m=s4pWaR5cf1z8+ah7ovG=iVDz9cSKWe_z$9zq(F!cXfAl zpL4a;=S-PTU|r{(_bd?>?EA!m?a4KJ0t?Uz7KMe# z9N&1_;LG}NPEd6*&(_sSyEcD=w(D958=IaiTqDDqQ^JX4WpDe}{b zJX?|HC~}@hcF=RK#UhT`zc271xyYkuxmb})6uDH9S17Vjy^bQpDP6fc6$^&iYi6kqsXr*vaZN`6?vZ`?^k3)kzZHj10?rk%ncu8 zfeOoqOvx=DR^)0$KBCA+^$xzn{39Ygsx)4OF&0>%aWr^g<;reO1j$?{och`N!L~Xz zq_iAk7NcK#;25G~+%NG;tYNjgjwQ2L^;SRhhRD|+5Q$+f|Fo8*jkQ>{P*J%sL}Z1f zIhs&|TD%yzteJSR&{w}077u$6;<#1ifxTtRNYP_ zH9BFBGhLQ03=%bIHsOj)Lvwv(WIhltE<{N*)n`Q)+Z+iN8d`v;*cT<%3~lHO-W12R zP>FU379*RaqlG9+O|TxHIo6Um?0M0RsuJ)r4uD-y+|=Fj7}exvzp z__yS)H6%AZMB(BnQSxlCzA0fikR_@M%R3pw;2Q)fr8GqTQX+kF=@)T8mL_hLQc!)FkRus5~Em7*UnxE4JQo3BMLj zaU&&E@B7e~z(bm zh+dx33${0)rAYWAN@UYeo$Zg~P5o^9T=J`T?bzQJZ8b);|%>WQ4@38HJUQ*`ZHSNzobUuY*f4S0xp+gSAP`xV;jZTn@w(SdD~eqo!l zH|e$h9f6K|rvagwqZ38ls^`tmk+-J^blWHMp?UQ zk+N_(!bMX*m$;hd5B(cSX?RqR z8t>mg!bxyjDEVinql46{o}y@$TUMv=rP~o_C?e%CZ`z0@M_kg}4@)K|(SdsUs!Ui1YI6nFhU+z}XKIc?JOy27`-SKk>xzL) z{nGlsY8WC8RUE}oF~4#;hMBW6gl6Sf2%_|ajeB4l3azy~)(Ih^^A=xmf731u)pxzT z3Xb9IFJ6pX6RuC#k_y*{+<`wc`wO#=M8FTB?FX_rh*>7HPnZp6_87CrnGIoP9+bma z`Wv(17Jt!bTPO#LtGSjdhx>aJ4A?b$X2ncT4scxl8BeUTA@vD*!}2M!&zN0gc8S?#i$X@%gB;NDfdBn(}`wfA@G$uLf{g&+dD<>L7TAe z?dU&>lWiy&b`yomLd5PRE|EXYS6oPol~sPUf2-!e?lQC835}cOlObCednHDT^nLv> zR-8XPRCe?y-_AyOSS0UXZOsbw5!nY@h~yNT$T;8>HD{tl&Dq|1u90oWllu9?gRErZ zCtN2|%)02~1N1XBB@T?!N1hCX?FuxzINv^4Ja?))8TyNo({bX(gURC3nO>sh+Yuz! z)k{uqbYQ$_bFLf{#0Te&Vxkb|4`Gs?{{HvAK9ecB(E5mD+k-@QC!4&|9WC^tj|2TM zMc;763hQJoMApkikhr?tS3mmsT^pwA)n9)EOw-G*uG1XTd3vJ7+N*6SIR@(m*T(`Q zW!DNc&~M*JvBpJF97YgXMl$=HSr)S|nEjpEm(0ErQ*Whf(=9T#9%5*3e0nR5?8BqDY;jc5wdRHDg5wazVJ zgxnqF>7$MYS+aO_a!0wJ+|94Vv|9r_y=>|rg~j4y)C}Yan`Rj7oSN%vSK|Q&#p*cSrZMHo!7}yk3j>|KwP>ICyMVyV42u)FVgl5 zG$&1Rl&A`D%5!yKcOUcxTCm$)&M-LTy5*Fj6YsaMzevkCi;mw%<%TYBimU}rz50Fx z?8{020qH}^Xa(-Oi)1T`jFvW}1I0$Z9bJGDdBg$3QOXN_h}U%GT|6W&R?@1Co{0!) zpG#+RzwW_CdtbB%Rv1tFVVMSDz=<3UFUc7Jh{QLtBmk4J(nQv)+B5D$DQ%ro^jq(e z6GPxMvI21$a$^`0@vVF(3>~msme#|+8WeF9i<*E7lpMk@x^uFULh=3O2~|(ddVA*{CrNSu3=~Vs!fuRFKn1Y>BZpEH_G9W4;yFWJLiQ$f!Xyvo)EBlO>~R9?}lYGn&!2mNtLc16qRM&kwE$;Y&BNqbf;)VwMDomLY_`p*K2j$4JAKL z?YjFWLwlk%bwR1I{zFS}H<0}}EtmzxF23W-X@jYEH@J5B~U2Ml`zG24V3b|0g0A1%jlEg#xu4cPQB3_?d|Tx z@QZo(tQrdDL$&W_@XSZc(}U6Wzr@N_hTZbc;~0xuGHVD1J9hG^vQ-xKqC5QZYG32x z5L#MzMHWv-PoG`pnH427#-g7*TSy0Wa)QkW7=a$J-qfOH>2!oh*CeFM-6N4eW24h( z7IiQq3yU4Q*>g93H%Imzg(LJvg7OCScnGOtYE|=T8%LNE#(7!t4xuRw^J-G%qCDFC z2fLuIpEoQm-SZnZ8Jp#gV=xF+MqlbGu-hnm5)*+v^8PrSd4P5>Cm`Ozd=FE1v2~LM zS+5B5q57Ynn?24n=QKJ;P-@F$Ha`s4|0#*NhLR zV=bT?Gjb6K>@^B!U^ISjU$__gB3v`-%>v-Rj~nVkqv;`LJR2o4w%cS^e+tn4E=Uno z>zte>_sNd45%>S~xSu_4`hAZEdF)~(Z|P>(4N4bDuzsg?aL)qmvT-uqm(GDjeD@kr zpAO1s!zp|}i4`U5VqwTd`FQF-bcRyoOSFb)c=u$RLOhPwjirTn1J>^~7k>;$*9tn$ z<~)ltn!1gC&m-x7lSqD$flF}18_EJ%_yR6aTFF{U$MTPI!&02b0V8)A9<$=_Kx55r>fW?6q?mT#xDv$Uby-q^+y=irHlX>-f%WNzM`4l6 zGT`UFU~JL?C8rEIq7CY$)~GUhJ1S+oy9k`xLVZ$cKP#x z)U39mn36>D1}sFiv1@ck=H8m zEnbxuHev^M$QL$YNx*GBq`7D`B02{$5hXjnj1f^gS-FeZZe~@?_AoR5vFY*v88zI? zihaz?KWT>7nMHQnghyq^O|+yJZpKu{>uhsCUf+zoI_5vLL##L~pV~r)LN)ycvW^Gh^;XWHf{2^h=p*Y=(^E|UW&@Vnq&A!R58+~yUk8hI?zpg| zM1^5BGqe2D$lr!Fco>YDyLI#dNhMwd2`b>6%|$c%zk&5Q)n}&;>0e{$VF#&(ka4`XY z=5Vp|SooWWi=Ek2xnn1qqK)l^Kg*>2el=BOY~1#?v}PX+T; zus{V1Rglksui@qw6$@N^cyx_JRYZ-cw_4ac_;8 z0KMR_YUbVgrne(%%~1xmE3rncI;Mi-DtJQ$Z>r#g3f}Snjh`n~aEicbqPIEH?{NEP zNO+e+{T@**IO_rD=xP2B;6oMsSp|PlK!N2W1zG-A1%Fk+ z$11p>f=^WNHx*n|!6gD*Y&?j|rbwWG(WhR-&(BnFMFpR$;0qP}T?JpN;42k;?E(J$ z{KfzFEw<-v)$qi0P_Om3OdGC8qL-Xm>>^nSEm-lRvnkAHG- zMxVJ;#!pT6SVm^fooSrdi#=M`I&Pbi~)Zn?f<2W5;Js%$f5`r61e%nmT&I zOpg`4$X3Q=19$9l$6FZh6Y5sUjKgRc9OMQW)TN$zW5?yrnv^r$7+HjDR^CbPy`9FkQt6=~D diff --git a/index-frames.html b/index-frames.html index 6770bbe..80cf4c3 100644 --- a/index-frames.html +++ b/index-frames.html @@ -1,4 +1,4 @@ -hpath-0.8.0: Support for well-typed paths \ No newline at end of file diff --git a/index.html b/index.html index 17ef648..4a5e212 100644 --- a/index.html +++ b/index.html @@ -1,4 +1,4 @@ -hpath-0.8.0: Support for well-typed paths

    hpath-0.8.0: Support for well-typed paths

    hpath-0.8.0: Support for well-typed paths

    Support for well-typed paths, utilizing ByteString under the hood.

    \ No newline at end of file +

    hpath-0.8.0: Support for well-typed paths

    hpath-0.8.0: Support for well-typed paths

    Support for well-typed paths, utilizing ByteString under the hood.

    \ No newline at end of file diff --git a/mini_HPath-IO-Errors.html b/mini_HPath-IO-Errors.html index 6aa95c4..24c3da5 100644 --- a/mini_HPath-IO-Errors.html +++ b/mini_HPath-IO-Errors.html @@ -1,4 +1,4 @@ -HPath.IO.Errors

    HPath.IO.Errors

    \ No newline at end of file diff --git a/mini_HPath-IO.html b/mini_HPath-IO.html index 8287dec..19a3271 100644 --- a/mini_HPath-IO.html +++ b/mini_HPath-IO.html @@ -1,4 +1,4 @@ -HPath.IO

    HPath.IO

    \ No newline at end of file diff --git a/mini_HPath.html b/mini_HPath.html index f1b0237..508fa77 100644 --- a/mini_HPath.html +++ b/mini_HPath.html @@ -1,4 +1,4 @@ -HPath

    HPath

    Types

    data Abs

    data Path b

    data Rel

    data Fn

    data PathParseException

    data PathException

    class RelC m

    PatternSynonyms/ViewPatterns

    Path Parsing

    parseAbs

    parseFn

    parseRel

    Path Conversion

    fromAbs

    fromRel

    toFilePath

    Path Operations

    (</>)

    basename

    dirname

    isParentOf

    getAllParents

    stripDir

    Path IO helpers

    withAbsPath

    withRelPath

    withFnPath

    \ No newline at end of file diff --git a/mini_System-Posix-Directory-Foreign.html b/mini_System-Posix-Directory-Foreign.html index 991dcbd..e45f7a2 100644 --- a/mini_System-Posix-Directory-Foreign.html +++ b/mini_System-Posix-Directory-Foreign.html @@ -1,4 +1,4 @@ -System.Posix.Directory.Foreign

    System.Posix.Directory.Foreign

    \ No newline at end of file diff --git a/mini_System-Posix-Directory-Traversals.html b/mini_System-Posix-Directory-Traversals.html index 281fb1a..dc1b13d 100644 --- a/mini_System-Posix-Directory-Traversals.html +++ b/mini_System-Posix-Directory-Traversals.html @@ -1,4 +1,4 @@ -System.Posix.Directory.Traversals

    System.Posix.Directory.Traversals

    \ No newline at end of file diff --git a/mini_System-Posix-FD.html b/mini_System-Posix-FD.html index 6c7914a..e5f3904 100644 --- a/mini_System-Posix-FD.html +++ b/mini_System-Posix-FD.html @@ -1,4 +1,4 @@ -System.Posix.FD

    System.Posix.FD

    \ No newline at end of file diff --git a/mini_System-Posix-FilePath.html b/mini_System-Posix-FilePath.html index e1d7491..578f4c9 100644 --- a/mini_System-Posix-FilePath.html +++ b/mini_System-Posix-FilePath.html @@ -1,4 +1,4 @@ -System.Posix.FilePath

    System.Posix.FilePath

    \ No newline at end of file diff --git a/ocean.css b/ocean.css index 3ebb14d..1110b40 100644 --- a/ocean.css +++ b/ocean.css @@ -41,9 +41,6 @@ a[href]:link { color: rgb(196,69,29); } a[href]:visited { color: rgb(171,105,84); } a[href]:hover { text-decoration:underline; } -a[href].def:link, a[href].def:visited { color: black; } -a[href].def:hover { color: rgb(78, 98, 114); } - /* @end */ /* @group Fonts & Sizes */ @@ -146,23 +143,15 @@ ul.links li a { background-image: url(plus.gif); background-repeat: no-repeat; } +p.caption.collapser, +p.caption.expander { + background-position: 0 0.4em; +} .collapser, .expander { padding-left: 14px; margin-left: -14px; cursor: pointer; } -p.caption.collapser, -p.caption.expander { - background-position: 0 0.4em; -} - -.instance.collapser, .instance.expander { - margin-left: 0px; - background-position: left center; - min-width: 9px; - min-height: 9px; -} - pre { padding: 0.25em; @@ -183,9 +172,6 @@ pre { .keyword { font-weight: normal; } .def { font-weight: bold; } -@media print { - #footer { display: none; } -} /* @end */ @@ -384,16 +370,21 @@ div#style-menu-holder { #interface h5 + div.top { margin-top: 1em; } -#interface .src .selflink, -#interface .src .link { +#interface p.src .link { float: right; color: #919191; + border-left: 1px solid #919191; background: #f0f0f0; padding: 0 0.5em 0.2em; - margin: 0 -0.5em 0 0; + margin: 0 -0.5em 0 0.5em; } -#interface .src .selflink { + +#interface td.src .link { + float: right; + color: #919191; border-left: 1px solid #919191; + background: #f0f0f0; + padding: 0 0.5em 0.2em; margin: 0 -0.5em 0 0.5em; } @@ -433,31 +424,30 @@ div#style-menu-holder { visibility: hidden; } -.subs ul { - list-style: none; - display: table; +.subs dl { margin: 0; } -.subs ul li { - display: table-row; -} - -.subs ul li dfn { - display: table-cell; - font-style: normal; - font-weight: bold; +.subs dt { + float: left; + clear: left; + display: block; margin: 1px 0; - white-space: nowrap; } -.subs ul li > .doc { - display: table-cell; +.subs dd { + float: right; + width: 90%; + display: block; padding-left: 0.5em; margin-bottom: 0.5em; } -.subs ul li > .doc p { +.subs dd.empty { + display: none; +} + +.subs dd p { margin: 0; } diff --git a/src/HPath-IO-Errors.html b/src/HPath-IO-Errors.html index 2f8eb4b..34673e7 100644 --- a/src/HPath-IO-Errors.html +++ b/src/HPath-IO-Errors.html @@ -18,349 +18,350 @@ -- -- Provides error handling. -{-# LANGUAGE ScopedTypeVariables #-} - -module HPath.IO.Errors - ( - -- * Types - HPathIOException(..) - , RecursiveFailureHint(..) - - -- * Exception identifiers - , isSameFile - , isDestinationInSource - , isRecursiveFailure - , isReadContentsFailed - , isCreateDirFailed - , isCopyFileFailed - , isRecreateSymlinkFailed - - -- * Path based functions - , throwFileDoesExist - , throwDirDoesExist - , throwSameFile - , sameFile - , throwDestinationInSource - , doesFileExist - , doesDirectoryExist - , isWritable - , canOpenDirectory - - -- * Error handling functions - , catchErrno - , rethrowErrnoAs - , handleIOError - , bracketeer - , reactOnError - ) - where - +{-# LANGUAGE DeriveDataTypeable #-} +{-# LANGUAGE ScopedTypeVariables #-} + +module HPath.IO.Errors + ( + -- * Types + HPathIOException(..) + , RecursiveFailureHint(..) + + -- * Exception identifiers + , isSameFile + , isDestinationInSource + , isRecursiveFailure + , isReadContentsFailed + , isCreateDirFailed + , isCopyFileFailed + , isRecreateSymlinkFailed + + -- * Path based functions + , throwFileDoesExist + , throwDirDoesExist + , throwSameFile + , sameFile + , throwDestinationInSource + , doesFileExist + , doesDirectoryExist + , isWritable + , canOpenDirectory + + -- * Error handling functions + , catchErrno + , rethrowErrnoAs + , handleIOError + , bracketeer + , reactOnError + ) + where -import Control.Applicative - ( - (<$>) - ) -import Control.Exception -import Control.Monad - ( - forM - , when - ) -import Control.Monad.IfElse - ( - whenM - ) -import Data.ByteString - ( - ByteString - ) -import Data.ByteString.UTF8 - ( - toString - ) -import Data.Typeable - ( - Typeable - ) -import Foreign.C.Error - ( - getErrno - , Errno - ) -import GHC.IO.Exception - ( - IOErrorType - ) -import HPath -import {-# SOURCE #-} HPath.IO - ( - canonicalizePath - ) -import System.IO.Error - ( - alreadyExistsErrorType - , catchIOError - , ioeGetErrorType - , mkIOError - ) - -import qualified System.Posix.Directory.ByteString as PFD -import System.Posix.Files.ByteString - ( - fileAccess - , getFileStatus - ) -import qualified System.Posix.Files.ByteString as PF - + +import Control.Applicative + ( + (<$>) + ) +import Control.Exception +import Control.Monad + ( + forM + , when + ) +import Control.Monad.IfElse + ( + whenM + ) +import Data.ByteString + ( + ByteString + ) +import Data.ByteString.UTF8 + ( + toString + ) +import Data.Typeable + ( + Typeable + ) +import Foreign.C.Error + ( + getErrno + , Errno + ) +import GHC.IO.Exception + ( + IOErrorType + ) +import HPath +import {-# SOURCE #-} HPath.IO + ( + canonicalizePath + ) +import System.IO.Error + ( + alreadyExistsErrorType + , catchIOError + , ioeGetErrorType + , mkIOError + ) + +import qualified System.Posix.Directory.ByteString as PFD +import System.Posix.Files.ByteString + ( + fileAccess + , getFileStatus + ) +import qualified System.Posix.Files.ByteString as PF --- |Additional generic IO exceptions that the posix functions --- do not provide. -data HPathIOException = SameFile ByteString ByteString - | DestinationInSource ByteString ByteString - | RecursiveFailure [(RecursiveFailureHint, IOException)] - deriving (Eq, Show, Typeable) - + +-- |Additional generic IO exceptions that the posix functions +-- do not provide. +data HPathIOException = SameFile ByteString ByteString + | DestinationInSource ByteString ByteString + | RecursiveFailure [(RecursiveFailureHint, IOException)] + deriving (Eq, Show, Typeable) --- |A type for giving failure hints on recursive failure, which allows --- to programmatically make choices without examining --- the weakly typed I/O error attributes (like `ioeGetFileName`). --- --- The first argument to the data constructor is always the --- source and the second the destination. -data RecursiveFailureHint = ReadContentsFailed (Path Abs) (Path Abs) - | CreateDirFailed (Path Abs) (Path Abs) - | CopyFileFailed (Path Abs) (Path Abs) - | RecreateSymlinkFailed (Path Abs) (Path Abs) - deriving (Eq, Show) - + +-- |A type for giving failure hints on recursive failure, which allows +-- to programmatically make choices without examining +-- the weakly typed I/O error attributes (like `ioeGetFileName`). +-- +-- The first argument to the data constructor is always the +-- source and the second the destination. +data RecursiveFailureHint = ReadContentsFailed (Path Abs) (Path Abs) + | CreateDirFailed (Path Abs) (Path Abs) + | CopyFileFailed (Path Abs) (Path Abs) + | RecreateSymlinkFailed (Path Abs) (Path Abs) + deriving (Eq, Show) -instance Exception HPathIOException - + +instance Exception HPathIOException -toConstr :: HPathIOException -> String -toConstr SameFile {} = "SameFile" -toConstr DestinationInSource {} = "DestinationInSource" -toConstr RecursiveFailure {} = "RecursiveFailure" - + +toConstr :: HPathIOException -> String +toConstr SameFile {} = "SameFile" +toConstr DestinationInSource {} = "DestinationInSource" +toConstr RecursiveFailure {} = "RecursiveFailure" - ----------------------------- - --[ Exception identifiers ]-- - ----------------------------- - + + ----------------------------- + --[ Exception identifiers ]-- + ----------------------------- -isSameFile, isDestinationInSource, isRecursiveFailure :: HPathIOException -> Bool -isSameFile ex = toConstr (ex :: HPathIOException) == toConstr SameFile{} -isDestinationInSource ex = toConstr (ex :: HPathIOException) == toConstr DestinationInSource{} -isRecursiveFailure ex = toConstr (ex :: HPathIOException) == toConstr RecursiveFailure{} - + +isSameFile, isDestinationInSource, isRecursiveFailure :: HPathIOException -> Bool +isSameFile ex = toConstr (ex :: HPathIOException) == toConstr SameFile{} +isDestinationInSource ex = toConstr (ex :: HPathIOException) == toConstr DestinationInSource{} +isRecursiveFailure ex = toConstr (ex :: HPathIOException) == toConstr RecursiveFailure{} -isReadContentsFailed, isCreateDirFailed, isCopyFileFailed, isRecreateSymlinkFailed ::RecursiveFailureHint -> Bool -isReadContentsFailed ReadContentsFailed{} = True -isReadContentsFailed _ = False -isCreateDirFailed CreateDirFailed{} = True -isCreateDirFailed _ = False -isCopyFileFailed CopyFileFailed{} = True -isCopyFileFailed _ = False -isRecreateSymlinkFailed RecreateSymlinkFailed{} = True -isRecreateSymlinkFailed _ = False - + +isReadContentsFailed, isCreateDirFailed, isCopyFileFailed, isRecreateSymlinkFailed ::RecursiveFailureHint -> Bool +isReadContentsFailed ReadContentsFailed{} = True +isReadContentsFailed _ = False +isCreateDirFailed CreateDirFailed{} = True +isCreateDirFailed _ = False +isCopyFileFailed CopyFileFailed{} = True +isCopyFileFailed _ = False +isRecreateSymlinkFailed RecreateSymlinkFailed{} = True +isRecreateSymlinkFailed _ = False - ---------------------------- - --[ Path based functions ]-- - ---------------------------- - + + ---------------------------- + --[ Path based functions ]-- + ---------------------------- --- |Throws `AlreadyExists` `IOError` if file exists. -throwFileDoesExist :: Path Abs -> IO () -throwFileDoesExist fp = - whenM (doesFileExist fp) - (ioError . mkIOError - alreadyExistsErrorType - "File already exists" - Nothing - $ (Just (toString $ fromAbs fp)) - ) - + +-- |Throws `AlreadyExists` `IOError` if file exists. +throwFileDoesExist :: Path Abs -> IO () +throwFileDoesExist fp = + whenM (doesFileExist fp) + (ioError . mkIOError + alreadyExistsErrorType + "File already exists" + Nothing + $ (Just (toString $ fromAbs fp)) + ) --- |Throws `AlreadyExists` `IOError` if directory exists. -throwDirDoesExist :: Path Abs -> IO () -throwDirDoesExist fp = - whenM (doesDirectoryExist fp) - (ioError . mkIOError - alreadyExistsErrorType - "Directory already exists" - Nothing - $ (Just (toString $ fromAbs fp)) - ) - + +-- |Throws `AlreadyExists` `IOError` if directory exists. +throwDirDoesExist :: Path Abs -> IO () +throwDirDoesExist fp = + whenM (doesDirectoryExist fp) + (ioError . mkIOError + alreadyExistsErrorType + "Directory already exists" + Nothing + $ (Just (toString $ fromAbs fp)) + ) --- |Uses `isSameFile` and throws `SameFile` if it returns True. -throwSameFile :: Path Abs - -> Path Abs - -> IO () -throwSameFile fp1 fp2 = - whenM (sameFile fp1 fp2) - (throwIO $ SameFile (fromAbs fp1) (fromAbs fp2)) - + +-- |Uses `isSameFile` and throws `SameFile` if it returns True. +throwSameFile :: Path Abs + -> Path Abs + -> IO () +throwSameFile fp1 fp2 = + whenM (sameFile fp1 fp2) + (throwIO $ SameFile (fromAbs fp1) (fromAbs fp2)) --- |Check if the files are the same by examining device and file id. --- This follows symbolic links. -sameFile :: Path Abs -> Path Abs -> IO Bool -sameFile fp1 fp2 = - withAbsPath fp1 $ \fp1' -> withAbsPath fp2 $ \fp2' -> - handleIOError (\_ -> return False) $ do - fs1 <- getFileStatus fp1' - fs2 <- getFileStatus fp2' - - if ((PF.deviceID fs1, PF.fileID fs1) == - (PF.deviceID fs2, PF.fileID fs2)) - then return True - else return False - + +-- |Check if the files are the same by examining device and file id. +-- This follows symbolic links. +sameFile :: Path Abs -> Path Abs -> IO Bool +sameFile fp1 fp2 = + withAbsPath fp1 $ \fp1' -> withAbsPath fp2 $ \fp2' -> + handleIOError (\_ -> return False) $ do + fs1 <- getFileStatus fp1' + fs2 <- getFileStatus fp2' + + if ((PF.deviceID fs1, PF.fileID fs1) == + (PF.deviceID fs2, PF.fileID fs2)) + then return True + else return False --- TODO: make this more robust when destination does not exist --- |Checks whether the destination directory is contained --- within the source directory by comparing the device+file ID of the --- source directory with all device+file IDs of the parent directories --- of the destination. -throwDestinationInSource :: Path Abs -- ^ source dir - -> Path Abs -- ^ full destination, @dirname dest@ - -- must exist - -> IO () -throwDestinationInSource source dest = do - dest' <- (\x -> maybe x (\y -> x </> y) $ basename dest) - <$> (canonicalizePath $ dirname dest) - dids <- forM (getAllParents dest') $ \p -> do - fs <- PF.getSymbolicLinkStatus (fromAbs p) - return (PF.deviceID fs, PF.fileID fs) - sid <- fmap (\x -> (PF.deviceID x, PF.fileID x)) - $ PF.getFileStatus (fromAbs source) - when (elem sid dids) - (throwIO $ DestinationInSource (fromAbs dest) - (fromAbs source)) - + +-- TODO: make this more robust when destination does not exist +-- |Checks whether the destination directory is contained +-- within the source directory by comparing the device+file ID of the +-- source directory with all device+file IDs of the parent directories +-- of the destination. +throwDestinationInSource :: Path Abs -- ^ source dir + -> Path Abs -- ^ full destination, @dirname dest@ + -- must exist + -> IO () +throwDestinationInSource source dest = do + dest' <- (\x -> maybe x (\y -> x </> y) $ basename dest) + <$> (canonicalizePath $ dirname dest) + dids <- forM (getAllParents dest') $ \p -> do + fs <- PF.getSymbolicLinkStatus (fromAbs p) + return (PF.deviceID fs, PF.fileID fs) + sid <- fmap (\x -> (PF.deviceID x, PF.fileID x)) + $ PF.getFileStatus (fromAbs source) + when (elem sid dids) + (throwIO $ DestinationInSource (fromAbs dest) + (fromAbs source)) --- |Checks if the given file exists and is not a directory. --- Does not follow symlinks. -doesFileExist :: Path Abs -> IO Bool -doesFileExist fp = - handleIOError (\_ -> return False) $ do - fs <- PF.getSymbolicLinkStatus (fromAbs fp) - return $ not . PF.isDirectory $ fs - + +-- |Checks if the given file exists and is not a directory. +-- Does not follow symlinks. +doesFileExist :: Path Abs -> IO Bool +doesFileExist fp = + handleIOError (\_ -> return False) $ do + fs <- PF.getSymbolicLinkStatus (fromAbs fp) + return $ not . PF.isDirectory $ fs --- |Checks if the given file exists and is a directory. --- Does not follow symlinks. -doesDirectoryExist :: Path Abs -> IO Bool -doesDirectoryExist fp = - handleIOError (\_ -> return False) $ do - fs <- PF.getSymbolicLinkStatus (fromAbs fp) - return $ PF.isDirectory fs - + +-- |Checks if the given file exists and is a directory. +-- Does not follow symlinks. +doesDirectoryExist :: Path Abs -> IO Bool +doesDirectoryExist fp = + handleIOError (\_ -> return False) $ do + fs <- PF.getSymbolicLinkStatus (fromAbs fp) + return $ PF.isDirectory fs --- |Checks whether a file or folder is writable. -isWritable :: Path Abs -> IO Bool -isWritable fp = - handleIOError (\_ -> return False) $ - fileAccess (fromAbs fp) False True False - + +-- |Checks whether a file or folder is writable. +isWritable :: Path Abs -> IO Bool +isWritable fp = + handleIOError (\_ -> return False) $ + fileAccess (fromAbs fp) False True False --- |Checks whether the directory at the given path exists and can be --- opened. This invokes `openDirStream` which follows symlinks. -canOpenDirectory :: Path Abs -> IO Bool -canOpenDirectory fp = - handleIOError (\_ -> return False) $ do - bracket (PFD.openDirStream . fromAbs $ fp) - PFD.closeDirStream - (\_ -> return ()) - return True - + +-- |Checks whether the directory at the given path exists and can be +-- opened. This invokes `openDirStream` which follows symlinks. +canOpenDirectory :: Path Abs -> IO Bool +canOpenDirectory fp = + handleIOError (\_ -> return False) $ do + bracket (PFD.openDirStream . fromAbs $ fp) + PFD.closeDirStream + (\_ -> return ()) + return True - -------------------------------- - --[ Error handling functions ]-- - -------------------------------- - + + -------------------------------- + --[ Error handling functions ]-- + -------------------------------- --- |Carries out an action, then checks if there is an IOException and --- a specific errno. If so, then it carries out another action, otherwise --- it rethrows the error. -catchErrno :: [Errno] -- ^ errno to catch - -> IO a -- ^ action to try, which can raise an IOException - -> IO a -- ^ action to carry out in case of an IOException and - -- if errno matches - -> IO a -catchErrno en a1 a2 = - catchIOError a1 $ \e -> do - errno <- getErrno - if errno `elem` en - then a2 - else ioError e - + +-- |Carries out an action, then checks if there is an IOException and +-- a specific errno. If so, then it carries out another action, otherwise +-- it rethrows the error. +catchErrno :: [Errno] -- ^ errno to catch + -> IO a -- ^ action to try, which can raise an IOException + -> IO a -- ^ action to carry out in case of an IOException and + -- if errno matches + -> IO a +catchErrno en a1 a2 = + catchIOError a1 $ \e -> do + errno <- getErrno + if errno `elem` en + then a2 + else ioError e --- |Execute the given action and retrow IO exceptions as a new Exception --- that have the given errno. If errno does not match the exception is rethrown --- as is. -rethrowErrnoAs :: Exception e - => [Errno] -- ^ errno to catch - -> e -- ^ rethrow as if errno matches - -> IO a -- ^ action to try - -> IO a -rethrowErrnoAs en fmex action = catchErrno en action (throwIO fmex) - + +-- |Execute the given action and retrow IO exceptions as a new Exception +-- that have the given errno. If errno does not match the exception is rethrown +-- as is. +rethrowErrnoAs :: Exception e + => [Errno] -- ^ errno to catch + -> e -- ^ rethrow as if errno matches + -> IO a -- ^ action to try + -> IO a +rethrowErrnoAs en fmex action = catchErrno en action (throwIO fmex) --- |Like `catchIOError`, with arguments swapped. -handleIOError :: (IOError -> IO a) -> IO a -> IO a -handleIOError = flip catchIOError - + +-- |Like `catchIOError`, with arguments swapped. +handleIOError :: (IOError -> IO a) -> IO a -> IO a +handleIOError = flip catchIOError --- |Like `bracket`, but allows to have different clean-up --- actions depending on whether the in-between computation --- has raised an exception or not. -bracketeer :: IO a -- ^ computation to run first - -> (a -> IO b) -- ^ computation to run last, when - -- no exception was raised - -> (a -> IO b) -- ^ computation to run last, - -- when an exception was raised - -> (a -> IO c) -- ^ computation to run in-between - -> IO c -bracketeer before after afterEx thing = - mask $ \restore -> do - a <- before - r <- restore (thing a) `onException` afterEx a - _ <- after a - return r - + +-- |Like `bracket`, but allows to have different clean-up +-- actions depending on whether the in-between computation +-- has raised an exception or not. +bracketeer :: IO a -- ^ computation to run first + -> (a -> IO b) -- ^ computation to run last, when + -- no exception was raised + -> (a -> IO b) -- ^ computation to run last, + -- when an exception was raised + -> (a -> IO c) -- ^ computation to run in-between + -> IO c +bracketeer before after afterEx thing = + mask $ \restore -> do + a <- before + r <- restore (thing a) `onException` afterEx a + _ <- after a + return r -reactOnError :: IO a - -> [(IOErrorType, IO a)] -- ^ reaction on IO errors - -> [(HPathIOException, IO a)] -- ^ reaction on HPathIOException - -> IO a -reactOnError a ios fmios = - a `catches` [iohandler, fmiohandler] - where - iohandler = Handler $ - \(ex :: IOException) -> - foldr (\(t, a') y -> if ioeGetErrorType ex == t - then a' - else y) - (throwIO ex) - ios - fmiohandler = Handler $ - \(ex :: HPathIOException) -> - foldr (\(t, a') y -> if toConstr ex == toConstr t - then a' - else y) - (throwIO ex) - fmios - + +reactOnError :: IO a + -> [(IOErrorType, IO a)] -- ^ reaction on IO errors + -> [(HPathIOException, IO a)] -- ^ reaction on HPathIOException + -> IO a +reactOnError a ios fmios = + a `catches` [iohandler, fmiohandler] + where + iohandler = Handler $ + \(ex :: IOException) -> + foldr (\(t, a') y -> if ioeGetErrorType ex == t + then a' + else y) + (throwIO ex) + ios + fmiohandler = Handler $ + \(ex :: HPathIOException) -> + foldr (\(t, a') y -> if toConstr ex == toConstr t + then a' + else y) + (throwIO ex) + fmios +