haskell/conduit-resumablesink
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Improve documentation

Browse Source
This commit is contained in:
Andrew Miller 2012-12-20 23:03:56 +13:00
parent 84f6e97991
commit 126fce396a
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
hssrc/Data/Conduit/ResumableSink.hs
View File

@ -54,12 +54,17 @@ closeResumableSink (ResumableSink sink) =
Done r -> return r Done r -> return r
PipeM mp -> mp >>= go PipeM mp -> mp >>= go
-- | Connects a source and a sink. The result will be Right a
-- ResumableSink or Left result if the Sink completes.
(+$$) :: Monad m => Source m i -> Sink i m r -> m (Either r (ResumableSink m i r)) (+$$) :: Monad m => Source m i -> Sink i m r -> m (Either r (ResumableSink m i r))
source +$$ sink = source `connectResumeSink` (newResumableSink sink) source +$$ sink = source `connectResumeSink` (newResumableSink sink)
-- | Connects a new source to a resumable sink. The result will be Right an updated
-- ResumableSink or Left result if the Sink completes.
(++$$) :: Monad m => Source m i -> ResumableSink m i r -> m (Either r (ResumableSink m i r)) (++$$) :: Monad m => Source m i -> ResumableSink m i r -> m (Either r (ResumableSink m i r))
(++$$) = connectResumeSink (++$$) = connectResumeSink
-- | Attaches a source to a resumable sink, finishing the sink and returning a result.
(-++$$) :: Monad m => Source m i -> ResumableSink m i r -> m r (-++$$) :: Monad m => Source m i -> ResumableSink m i r -> m r
source -++$$ (ResumableSink sink) = do source -++$$ (ResumableSink sink) = do
r <- source $$ sink r <- source $$ sink