projects
/
haskell-directory.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
[project @ 2002-05-09 13:16:29 by simonmar]
[haskell-directory.git]
/
Foreign
/
Marshal
/
Error.hs
diff --git
a/Foreign/Marshal/Error.hs
b/Foreign/Marshal/Error.hs
index
1020f8a
..
46fa2b7
100644
(file)
--- a/
Foreign/Marshal/Error.hs
+++ b/
Foreign/Marshal/Error.hs
@@
-3,7
+3,7
@@
-- |
-- Module : Foreign.Marshal.Error
-- Copyright : (c) The FFI task force 2001
-- |
-- Module : Foreign.Marshal.Error
-- Copyright : (c) The FFI task force 2001
--- License : BSD-style (see the file libraries/core/LICENSE)
+-- License : BSD-style (see the file libraries/base/LICENSE)
--
-- Maintainer : ffi@haskell.org
-- Stability : provisional
--
-- Maintainer : ffi@haskell.org
-- Stability : provisional
@@
-14,8
+14,9
@@
-----------------------------------------------------------------------------
module Foreign.Marshal.Error (
-----------------------------------------------------------------------------
module Foreign.Marshal.Error (
+ -- * Error utilities
- -- throw an exception on specific return values
+ -- |Throw an exception on specific return values
--
throwIf, -- :: (a -> Bool) -> (a -> String) -> IO a -> IO a
throwIf_, -- :: (a -> Bool) -> (a -> String) -> IO a -> IO ()
--
throwIf, -- :: (a -> Bool) -> (a -> String) -> IO a -> IO a
throwIf_, -- :: (a -> Bool) -> (a -> String) -> IO a -> IO ()
@@
-25,7
+26,7
@@
module Foreign.Marshal.Error (
-- => (a -> String) -> IO a -> IO ()
throwIfNull, -- :: String -> IO (Ptr a) -> IO (Ptr a)
-- => (a -> String) -> IO a -> IO ()
throwIfNull, -- :: String -> IO (Ptr a) -> IO (Ptr a)
- -- discard return value
+ -- Discard return value
--
void -- IO a -> IO ()
) where
--
void -- IO a -> IO ()
) where
@@
-41,10
+42,10
@@
import GHC.IOBase
-- exported functions
-- ------------------
-- exported functions
-- ------------------
--- guard an IO operation and throw an exception if the result meets the given
+-- |Guard an 'IO' operation and throw an exception if the result meets the given
-- predicate
--
-- predicate
--
--- * the second argument computes an error message from the result of the IO
+-- * the second argument computes an error message from the result of the 'IO'
-- operation
--
throwIf :: (a -> Bool) -> (a -> String) -> IO a -> IO a
-- operation
--
throwIf :: (a -> Bool) -> (a -> String) -> IO a -> IO a
@@
-53,27
+54,27
@@
throwIf pred msgfct act =
res <- act
(if pred res then ioError . userError . msgfct else return) res
res <- act
(if pred res then ioError . userError . msgfct else return) res
--- like `throwIf', but discarding the result
+-- |Like 'throwIf', but discarding the result
--
throwIf_ :: (a -> Bool) -> (a -> String) -> IO a -> IO ()
throwIf_ pred msgfct act = void $ throwIf pred msgfct act
--
throwIf_ :: (a -> Bool) -> (a -> String) -> IO a -> IO ()
throwIf_ pred msgfct act = void $ throwIf pred msgfct act
--- guards against negative result values
+-- |Guards against negative result values
--
throwIfNeg :: (Ord a, Num a) => (a -> String) -> IO a -> IO a
throwIfNeg = throwIf (< 0)
--
throwIfNeg :: (Ord a, Num a) => (a -> String) -> IO a -> IO a
throwIfNeg = throwIf (< 0)
--- like `throwIfNeg', but discarding the result
+-- |Like 'throwIfNeg', but discarding the result
--
throwIfNeg_ :: (Ord a, Num a) => (a -> String) -> IO a -> IO ()
throwIfNeg_ = throwIf_ (< 0)
--
throwIfNeg_ :: (Ord a, Num a) => (a -> String) -> IO a -> IO ()
throwIfNeg_ = throwIf_ (< 0)
--- guards against null pointers
+-- |Guards against null pointers
--
throwIfNull :: String -> IO (Ptr a) -> IO (Ptr a)
throwIfNull = throwIf (== nullPtr) . const
--
throwIfNull :: String -> IO (Ptr a) -> IO (Ptr a)
throwIfNull = throwIf (== nullPtr) . const
--- discard the return value of an IO action
+-- |Discard the return value of an 'IO' action
--
void :: IO a -> IO ()
void act = act >> return ()
--
void :: IO a -> IO ()
void act = act >> return ()