From f7ea89b9904f56d249bf980693779549e6d8ff91 Mon Sep 17 00:00:00 2001 From: travis-ci Date: Sat, 14 Jan 2017 19:26:51 +0000 Subject: [PATCH] Lastest docs updated travis build: 87 commit: 1a2c77c6a6f14483ce1b88805bd9ae0963f2cf81 auto-pushed to gh-pages --- HPath-IO-Errors.html | 28 +++++----- HPath-IO.html | 38 +++++++------- HPath.html | 16 +++--- System-Posix-Directory-Foreign.html | 4 +- System-Posix-Directory-Traversals.html | 8 +-- System-Posix-FD.html | 6 +-- System-Posix-FilePath.html | 70 ++++++++++++------------- doc-index-60.html | 2 +- doc-index-A.html | 2 +- doc-index-All.html | 2 +- doc-index-B.html | 2 +- doc-index-C.html | 2 +- doc-index-D.html | 2 +- doc-index-E.html | 2 +- doc-index-F.html | 2 +- doc-index-G.html | 2 +- doc-index-H.html | 2 +- doc-index-I.html | 2 +- doc-index-J.html | 2 +- doc-index-M.html | 2 +- doc-index-N.html | 2 +- doc-index-O.html | 2 +- doc-index-P.html | 2 +- doc-index-R.html | 2 +- doc-index-S.html | 2 +- doc-index-T.html | 2 +- doc-index-U.html | 2 +- doc-index-W.html | 2 +- doc-index.html | 2 +- hpath.haddock | Bin 116743 -> 116724 bytes index.html | 2 +- ocean.css | 23 ++++++++ 32 files changed, 131 insertions(+), 108 deletions(-) diff --git a/HPath-IO-Errors.html b/HPath-IO-Errors.html index e7bae2a..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. + 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 + 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 df2f8ea..2d56bfb 100644 --- a/HPath-IO.html +++ b/HPath-IO.html @@ -16,7 +16,7 @@ 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.

Synopsis

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, @@ -25,7 +25,7 @@ window.onload = function () {pageLoad();setSynopsis("mini_HPath-IO.html");}; 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. + 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 03c7c22..97d2bfd 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-Inferred
    LanguageHaskell2010

    HPath

    Description

    Support for well-typed paths.

    Synopsis

    Types

    data Abs Source

    An absolute path.

    Instances

    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)

    ByteString equality.

    The following property holds:

    show x == show y ≡ x == y
    Ord (Path b)

    ByteString ordering.

    The following property holds:

    show x `compare` show y ≡ x `compare` y
    Show (Path b)

    Same as toFilePath.

    The following property holds:

    x == y ≡ show x == show y
    NFData (Path b) 
    Typeable (* -> *) Path 

    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 t 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)
@@ -78,7 +78,7 @@ window.onload = function () {pageLoad();setSynopsis("mini_HPath.html");};
 "/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")
@@ -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 54490ea..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-Inferred
    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 +

    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 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 06fba95..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 72c7cb3..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-Inferred
    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 6d24f2b..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-Inferred
    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 577fa05..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 57469b6..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 5e533a1..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 a27a72d..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 1b1b7ff..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 630da4e..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 bfadf46..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 f4f82db..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 280a54b..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 28973a3..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 aed7224..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 93fd238..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 5b84e8d..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 6fe01a3..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 d3dba5a..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 13a8623..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 53bc2c1..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 aeef933..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 1709284..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 1abb33e..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 116f62c..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 31723f3..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/hpath.haddock b/hpath.haddock index 090490a2f8370df366fa7c224075941a3d9ad371..bd6dc35f588fd00d11a1a80bd95533819d799ed3 100644 GIT binary patch delta 3619 zcmZ`64OEm>_PgHJG!E8h&vGDRCDNh%?zAgCg!1e$n&B-89Isc0H&07*UV z-)Qt=qAaqMr#w6LsB#`e`gWu5fC_xW4v{|D%;=EBzlNwl)S)SSp5FnT0&Ld58MW|5xa6g#3=vNLKWNve~aab8}M0pvgt-0l$T zhOebVbL_hYZ_)>{gHA)#%OgJpU4OV}DsbS%6<`w0HHz97{}}5iO_(Hm*uz9(g%w>2 zC~OJmgo0VU;rfc1dd8dwUp8c+>l9*fH2K*x)GQ`HI#QUEeCZPA*imXmQjSc_8 z(uL{S^r@mwnX%WS)+)M6t>S$5Fm?FMUNBMM?LWS2j&3PV1jjnXrc3^! z$!^A?W-tnSmLhJrywr=2_L5V3&XiIZL{w{(dbR9Ae+;63NUkD^9#rtNP*Bw1@^FsV zFDi09cW?@Kat!vY0HfMG_jj@{7ez2RQ6MUwjQd~W4pyD;Cb2~|T>-SDEt^8+E1K7o zh!Ne9;`-{h=&*TBBjt<4A0+V{ah!s@oQmhzP@_8Y`8LmmbH#@f?7Fo9TK-xGKaNG~ zBRuJuaG%qnbD2lQXB%fQTdMmx1IKAJ*_bNwXFAjiTX%bfWE09G--jo5BAIey#mU>K z@Z3A!R_DIz>rp>>;9Pa@T;Ct4FpN%xII+9Mq~`A0&w>1^xs&F$mRhnI)mmnx<+=SY z$q7II*nfES@ys%dU9j`>Q)_;+m8JXM2=|1*A{KYM)ZE{u4MyK-8)EoBuNe+U`;{uB zuavI*0KR4;C)-kuSQiB5tzjmy;BdbFLTtp6fn&1ig|yY!#P!3I$ocpq$dTe?W{8UR zsdBlb2DFd&AyPp5Ec7d)iX7b?As#=Xi01Y(;aF}Gr!Ix455KpT9+!IdgCM|kH`pvP z-zbiN`wByx3?e{tsbfwrWNkaUc5}~26uZ0PQSqgS*S9-GUiW;jd32mW$8p$11%`n| zL>t}B4dY1nEtBV==7=@jA?k?>>1Xg2dF{L>I>SZt^>M1}%Nl-nJFnMy2mFcb ze?stQg7f0|H_xg~w^o5t5JY$#MIGe5w9CMc%fK%34w*z-GqttbiJXJRyDriritkkk z^Svy6$5~dspJ`~2En>{25OFNkjEX-+X48JNX#PHuFZRU!71@`kh|cXMHK;E^@0I76 z?7+$1;6!&2C`UE}xglw80~C@u?QceytTT=pV0=YyptA;Wk05sotNAU1KV) zP6DgeYl0d|f5ZzSfG)XD;CIMejC&d;V#(&z@GxV=%q zs#v(9_u*UkaTd6==i=Z=uOY91%pdqs1Wrn@ByB@y71-cqG$(-5;FdqawsBzBrX|35 zUue))C&OjHp{Y=*B?5Z6#R?PV8e8OFluL0K>%#Vib-&i zE*JX{RFU3^9=!)2f+;{~6mH1`JKo(%NnNoSigETbaBAz)L6M;W*(xSZg0Z+c6DH!O zM_?J2WfB_j3QW{~p9$Vvq-U~VyODII=&F%akI)WIgDBP?GD!cf>Ez#;DhNYc9;Eqf zmmlW{VBh1^dX{9_v<-QXY=l>}<3&&pumgL>Lj*79RdCv4;}GkJVORK1PvvT=954#Ax)z{k!a^H>_IH zI34F~qa5-NCGGlZIPGI>0C_x>gcW<1!)SbO4GhC57f};mgr#iZzy^pm{7iPNTKHy& zltX`7p&!FIum>2EGQpGjRiX5ZCO1aahs4n z%YNiKBR6=W!M|LjUY=;^$XB${6|l9h2P5AMMs5y9ZVg8My=pLayC3-vt(02rH6Wk+^zUPUCH&1;$@!y*M5jJl2*p%rrQx+5!WshI{Y<)^@Qr54EpYEqd zl`LJNT~gtk3BNrGL-8L+!HQ>(Qs-zpN@=rnfX!qosi>*Uu3m&`9S}o}rKN+uc6A+a z2XJX81mgTo2*!1tB>gt;S~|gMG7*2}jHUIMaSXyS`4~0v2aZ9g-;_mla~Eb-K2tpx zdpoJXKVyl%kQS}<7!?{UCnRQ7EN@mY%EJpJQC@`6R z`S8@lDHTh!c_-kMjA7uY|Nv%S0dcRpMfuY-?LvZMUs7Gdp$KG|9HCEYZDhK*K$C>Yej@-@EtSckg@m z-Fx56w^ad;RtE$->_5J33AaF+7SwGy5Io8X2gR;IXum!di)9R>gfWv*$S7-r8qWZC zs==ah@2^9%ilYN#+H3nZDv2q# zu5}T$54ptDh-?G8)?19PjHmiVFhq5QArmC@Z$hX@g+y%I!vm0hHdb%?8X zUKK-g`ilCjSdl&UyiCo^g_82zB30VpIhdUWIW(t>re;U*Y@E2Xt2;H#hE?v(J>0s% z?xJOk$Hz}EgO$=NVQeZ#S8@7Nr~EE|7v#3PJeqiG;(R%5Qie}cjM#CPOYXSmGl&bd z(Q@aM(~!%j7Haadf=o@OOmEhtd!{Ww_MUsfA%9vr!cTZB^2O^7QR4X(2c@^79P)#Q zzk+=8k(s(oeypo5vn!=8QMFW;e_DUcFL+ej#b*WZAY0~c{!~{d7{*uOlDXTfATI`MMb4c?0?KDmd&+_53{<9CmX`Wiwz`l4`s^jhx!MI z?T02(&cE~ea65SJe}A!-IHwoSZFTy$2FMCtf+47A_wNEf$0v$ z!y4^$qA$JY#A%Wt7|BZdkT(#Kw4xK7!r9rNULCQ9*`t1D)0q$skBc4A>{~_5z)|o9oOc!f_t{S*ik-m}?^uq_MI2;@qB4vpxz(K&N6b z7FARdgV}!7oWDKQ99;@T7|kEa4u7t*gBH0l8|%$;ZX{?}XFB5W7>tF`a_E5`h%_6z zqZ{;vS|%N^BS9=4

    -Av6K4`_(D~L%XD-CVrbk-IL)+p-0zpLg#(;7l*n*HrSWEH z>f>gpW2z&zPHd%rB*Klg=A}gB*|c&{az0XM?Fj6v>ox$OGlNiMR;D6Pqi(4vBIiZ~ z@I~hg#=GESbx*@FI-iD_tYZ97+z0+17>2!CdsSyCF9WGWWq6R>8GHd}Hz3tqodJKC z>qcR-p|8~j((x#cfs&!#$TtjonXU;|a> zq3fnHWYEw-TtY6Dz)9ADh%-0kp$xyU1J_2>lQsb_nT->0S@)%N44o)KoX>kV1D_x8 z1cT~V!!RQz<2B7ZdoSi2KJncD7jIgCp7caK63y?Y;X^HjeXk-!`9AQbn}6N^8ptyY zOU-37k*%A5FG7f6el!=`U@k312VY&uCieo2q|dXEtX^k&wk!G(n=LT6Jiz&6c3pr9 z-F&hf=lxVTgedViv;HA`qS;g(QNNY)D0wAZ>sK4%@s(DyX$9U4Fv_9z_tgpdSm3x> z{AbuQ%=2pyt#$gPXbPl|Aslllv$05e1};yZzNo1V>KN5t=g~q zBEV$-KMLBh2_k?Kfwz@GRo(d3?;@-+PZLi24sf@6!Kr>b++xUH=lVf*e&fT;+n>bh z*4n`dHi%AEa}i0X#jDg@i^|2b-UI(e38GI#8f?)drF` zGcKs${j!a?$X`oy8}XGQE~$>2GHv-y#xr z-+W8rT`PUwh$uSQh|ctKBflUujff!Q2w&)E)g>N5q}7`5om+TEQL#Dk2%yo-CWO$W zCInM?6AM4p1Xrr<4sTKMC~sNuk~aNTmM{F{l6mTniE94&rPJpWE@&kzwj915$l%vaGUszJKxX*1# z1Co-HQYh$EUIo?wDK6DlWb#37I}+{ dX5695f@*n=v@M-hSt;cYW_CFv-w)g-5 diff --git a/index.html b/index.html index 1d5a152..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/ocean.css b/ocean.css index de43632..1110b40 100644 --- a/ocean.css +++ b/ocean.css @@ -318,6 +318,7 @@ div#style-menu-holder { height: 80%; top: 10%; padding: 0; + max-width: 75%; } #synopsis .caption { @@ -378,6 +379,15 @@ div#style-menu-holder { margin: 0 -0.5em 0 0.5em; } +#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; +} + #interface span.fixity { color: #919191; border-left: 1px solid #919191; @@ -406,6 +416,14 @@ div#style-menu-holder { margin-top: 0.8em; } +.clearfix:after { + clear: both; + content: " "; + display: block; + height: 0; + visibility: hidden; +} + .subs dl { margin: 0; } @@ -445,6 +463,11 @@ div#style-menu-holder { margin-left: 1em; } +/* Workaround for bug in Firefox (issue #384) */ +.inst-left { + float: left; +} + .top p.src { border-top: 1px solid #ccc; }