From 126fce396a82fe74c99701039f63509d11ed1502 Mon Sep 17 00:00:00 2001 From: Andrew Miller Date: Thu, 20 Dec 2012 23:03:56 +1300 Subject: [PATCH] Improve documentation --- hssrc/Data/Conduit/ResumableSink.hs | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/hssrc/Data/Conduit/ResumableSink.hs b/hssrc/Data/Conduit/ResumableSink.hs index d1ea890..108f078 100644 --- a/hssrc/Data/Conduit/ResumableSink.hs +++ b/hssrc/Data/Conduit/ResumableSink.hs @@ -54,12 +54,17 @@ closeResumableSink (ResumableSink sink) = Done r -> return r 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)) 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)) (++$$) = 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 source -++$$ (ResumableSink sink) = do r <- source $$ sink