Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Added documentation for unsafeLiftControlIO

  • Loading branch information...
commit b958426e2567388d3679c251b056eca0aeeb6f9d 1 parent f8b49ad
@basvandijk authored
Showing with 9 additions and 0 deletions.
  1. +9 −0 Control/Monad/Trans/Region/Internal.hs
View
9 Control/Monad/Trans/Region/Internal.hs
@@ -421,6 +421,15 @@ Note that a 'RegionT' is an instance of this class. For the rest there is a
catch-all @instance 'MonadControlIO' m => 'RegionControlIO' m@.
-}
class MonadIO mRegionControlIO m where
+ {-|
+ This function behaves like `liftControlIO` but can be used on regions.
+
+ Note that you can safely use this function to lift any control operator
+ other than `forkIO` into a region.
+
+ See the following why it's unsafe to lift `forkIO` using this function:
+ <https://github.com/basvandijk/regions/wiki/unsafeLiftControlIO>
+ -}
unsafeLiftControlIO ∷ (RunInBase m IOIO α) → m α
instance RegionControlIO prRegionControlIO (RegionT s pr) where
Please sign in to comment.
Something went wrong with that request. Please try again.