add catch/try
authorSimon Marlow <marlowsd@gmail.com>
Tue, 13 Jul 2010 13:28:19 +0000 (13:28 +0000)
committerSimon Marlow <marlowsd@gmail.com>
Tue, 13 Jul 2010 13:28:19 +0000 (13:28 +0000)
System/IO/Error.hs

index 657e59a..d998da8 100644 (file)
@@ -48,11 +48,39 @@ module System.IO.Error (
 
   ) where
 
-import "base" System.IO.Error hiding (IOError)
+import "base" System.IO.Error hiding (IOError,catch,try)
 import qualified "base" System.IO.Error as Base
-import Prelude hiding (IOError)
+import Prelude hiding (IOError,catch)
 
 -- | Errors of type 'IOError' are used by the 'IO' monad.  This is an
 -- abstract type; the module "System.IO.Error" provides functions to
 -- interrogate and construct values of type 'IOError'.
 type IOError = Base.IOError
+
+-- SDM: duplicated docs for catch and try, omitting the part about non-IO
+-- exceptions.
+
+-- | The 'catch' function establishes a handler that receives any 'IOError'
+-- raised in the action protected by 'catch'.  An 'IOError' is caught by
+-- the most recent handler established by 'catch'.  These handlers are
+-- not selective: all 'IOError's are caught.  Exception propagation
+-- must be explicitly provided in a handler by re-raising any unwanted
+-- exceptions.  For example, in
+--
+-- > f = catch g (\e -> if IO.isEOFError e then return [] else ioError e)
+--
+-- the function @f@ returns @[]@ when an end-of-file exception
+-- (cf. 'System.IO.Error.isEOFError') occurs in @g@; otherwise, the
+-- exception is propagated to the next outer handler.
+--
+-- When an exception propagates outside the main program, the Haskell
+-- system prints the associated 'IOError' value and exits the program.
+--
+catch :: IO a -> (IOError -> IO a) -> IO a
+catch = Base.catch
+
+-- | The construct 'try' @comp@ exposes IO errors which occur within a
+-- computation, and which are not fully handled.
+--
+try            :: IO a -> IO (Either IOError a)
+try = Base.try