diff options
| author | Don Stewart <dons@cse.unsw.edu.au> | 2006-06-09 07:59:24 +0000 |
|---|---|---|
| committer | Don Stewart <dons@cse.unsw.edu.au> | 2006-06-09 07:59:24 +0000 |
| commit | 7aa1ae224d75da867313fd9be84efdcd24c6ce53 (patch) | |
| tree | d2cd43d7bbc0dbfe605340caa6e0a062bb364e0a /libraries/base/GHC/ForeignPtr.hs | |
| parent | e5c1c21244c9b3d0f2bea563b03febc9bcaaf596 (diff) | |
| download | haskell-7aa1ae224d75da867313fd9be84efdcd24c6ce53.tar.gz | |
Wibble in docs for new ForeignPtr functionsn
Diffstat (limited to 'libraries/base/GHC/ForeignPtr.hs')
| -rw-r--r-- | libraries/base/GHC/ForeignPtr.hs | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/libraries/base/GHC/ForeignPtr.hs b/libraries/base/GHC/ForeignPtr.hs index b0850df81d..603a8f3f1c 100644 --- a/libraries/base/GHC/ForeignPtr.hs +++ b/libraries/base/GHC/ForeignPtr.hs @@ -183,7 +183,7 @@ mallocForeignPtrBytes (I# size) = do -- mallocPlainForeignPtr. This is useful for ForeignPtrs that will live -- only inside Haskell (such as those created for packed strings). -- Attempts to add a finalizer to a ForeignPtr created this way, or to --- finalize such a pointer, will have no effect. +-- finalize such a pointer, will throw an exception. -- mallocPlainForeignPtr :: Storable a => IO (ForeignPtr a) mallocPlainForeignPtr = doMalloc undefined @@ -197,7 +197,8 @@ mallocPlainForeignPtr = doMalloc undefined -- | This function is similar to 'mallocForeignPtrBytes', except that -- the internally an optimised ForeignPtr representation with no --- finalizer is used. +-- finalizer is used. Attempts to add a finalizer will cause an +-- exception to be thrown. mallocPlainForeignPtrBytes :: Int -> IO (ForeignPtr a) mallocPlainForeignPtrBytes (I# size) = IO $ \s -> case newPinnedByteArray# size s of { (# s, mbarr# #) -> |