| Copyright | © 2016 Julian Ospald |
|---|---|
| License | BSD3 |
| Maintainer | Julian Ospald <hasufell@posteo.de> |
| Stability | experimental |
| Portability | portable |
| Safe Haskell | None |
| Language | Haskell2010 |
HPath.IO.Errors
Description
Provides error handling.
Synopsis
- data HPathIOException
- data RecursiveFailureHint
- isSameFile :: HPathIOException -> Bool
- isDestinationInSource :: HPathIOException -> Bool
- isRecursiveFailure :: HPathIOException -> Bool
- isReadContentsFailed :: RecursiveFailureHint -> Bool
- isCreateDirFailed :: RecursiveFailureHint -> Bool
- isCopyFileFailed :: RecursiveFailureHint -> Bool
- isRecreateSymlinkFailed :: RecursiveFailureHint -> Bool
- throwFileDoesExist :: Path b -> IO ()
- throwDirDoesExist :: Path b -> IO ()
- throwSameFile :: Path b1 -> Path b2 -> IO ()
- sameFile :: Path b1 -> Path b2 -> IO Bool
- throwDestinationInSource :: Path b1 -> Path b2 -> IO ()
- doesFileExist :: Path b -> IO Bool
- doesDirectoryExist :: Path b -> IO Bool
- isWritable :: Path b -> IO Bool
- canOpenDirectory :: Path b -> IO Bool
- catchErrno :: [Errno] -> IO a -> IO a -> IO a
- rethrowErrnoAs :: Exception e => [Errno] -> e -> IO a -> IO a
- handleIOError :: (IOError -> IO a) -> IO a -> IO a
- bracketeer :: IO a -> (a -> IO b) -> (a -> IO b) -> (a -> IO c) -> IO c
- reactOnError :: IO a -> [(IOErrorType, IO a)] -> [(HPathIOException, IO a)] -> IO a
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
| Eq HPathIOException Source # | |
Defined in HPath.IO.Errors Methods (==) :: HPathIOException -> HPathIOException -> Bool # (/=) :: HPathIOException -> HPathIOException -> Bool # | |
| Show HPathIOException Source # | |
Defined in HPath.IO.Errors Methods showsPrec :: Int -> HPathIOException -> ShowS # show :: HPathIOException -> String # showList :: [HPathIOException] -> ShowS # | |
| Exception HPathIOException Source # | |
Defined in HPath.IO.Errors Methods toException :: HPathIOException -> SomeException # | |
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 ByteString ByteString | |
| CreateDirFailed ByteString ByteString | |
| CopyFileFailed ByteString ByteString | |
| RecreateSymlinkFailed ByteString ByteString |
Instances
| Eq RecursiveFailureHint Source # | |
Defined in HPath.IO.Errors Methods (==) :: RecursiveFailureHint -> RecursiveFailureHint -> Bool # (/=) :: RecursiveFailureHint -> RecursiveFailureHint -> Bool # | |
| Show RecursiveFailureHint Source # | |
Defined in HPath.IO.Errors Methods showsPrec :: Int -> RecursiveFailureHint -> ShowS # show :: RecursiveFailureHint -> String # showList :: [RecursiveFailureHint] -> ShowS # | |
Exception identifiers
isSameFile :: HPathIOException -> Bool Source #
Path based functions
throwSameFile :: Path b1 -> Path b2 -> IO () Source #
Uses isSameFile and throws SameFile if it returns True.
sameFile :: Path b1 -> Path b2 -> IO Bool Source #
Check if the files are the same by examining device and file id. This follows symbolic links.
throwDestinationInSource Source #
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 b -> IO Bool Source #
Checks if the given file exists and is not a directory. Does not follow symlinks.
doesDirectoryExist :: Path b -> IO Bool Source #
Checks if the given file exists and is a directory. Does not follow symlinks.
canOpenDirectory :: Path b -> 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
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.
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.
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.
Arguments
| :: IO a | |
| -> [(IOErrorType, IO a)] | reaction on IO errors |
| -> [(HPathIOException, IO a)] | reaction on HPathIOException |
| -> IO a |