git.iko.soy/streamly
on master help sign in
Fix prelude documentation
ad58b1fHarendra Kumar
src/Streamly/Data/Stream/Concurrent.hs+15−14
compare with master
unifiedsplit
@@ -90,16 +90,17 @@
90
90
91module Streamly.Data.Stream.Concurrent
91module Streamly.Data.Stream.Concurrent
92 (
92 (
93+ -- * Concurrency
93 MonadAsync
94 MonadAsync
94
95
95− -- * Configuration
96+ -- ** Configuration
96 , Config
97 , Config
97
98
98− -- ** Limits
99+ -- *** Limits
99 , maxThreads
100 , maxThreads
100 , maxBuffer
101 , maxBuffer
101
102
102− -- ** Rate Control
103+ -- *** Rate Control
103 , Rate(..)
104 , Rate(..)
104 , rate
105 , rate
105 , avgRate
106 , avgRate
@@ -107,33 +108,33 @@ module Streamly.Data.Stream.Concurrent
107 , maxRate
108 , maxRate
108 , constRate
109 , constRate
109
110
110− -- ** Stop behavior
111+ -- *** Stop behavior
111 , StopWhen (..)
112 , StopWhen (..)
112 , stopWhen
113 , stopWhen
113
114
114− -- ** Scheduling behavior
115+ -- *** Scheduling behavior
115 , eager
116 , eager
116 , ordered
117 , ordered
117 , interleaved
118 , interleaved
118
119
119− -- ** Diagnostics
120+ -- *** Diagnostics
120 , inspect
121 , inspect
121
122
122− -- * Combinators
123+ -- ** Combinators
123 -- | Stream combinators using a concurrent channel.
124 -- | Stream combinators using a concurrent channel.
124
125
125− -- ** Evaluate
126+ -- *** Evaluate
126 -- | Evaluates a stream concurrently using a channel.
127 -- | Evaluates a stream concurrently using a channel.
127
128
128 -- , eval
129 -- , eval
129 , parEval
130 , parEval
130
131
131− -- ** Generate
132+ -- *** Generate
132 -- | Uses a single channel to evaluate mapped actions concurrently.
133 -- | Uses a single channel to evaluate mapped actions concurrently.
133 , parRepeatM
134 , parRepeatM
134 , parReplicateM
135 , parReplicateM
135
136
136− -- ** Map
137+ -- *** Map
137 -- | Uses a single channel to evaluate mapped actions concurrently.
138 -- | Uses a single channel to evaluate mapped actions concurrently.
138
139
139 -- , mapM
140 -- , mapM
@@ -141,7 +142,7 @@ module Streamly.Data.Stream.Concurrent
141 -- , sequence
142 -- , sequence
142 , parSequence
143 , parSequence
143
144
144− -- ** List of streams
145+ -- *** List of streams
145 -- | Shares a single channel across many streams.
146 -- | Shares a single channel across many streams.
146
147
147 -- , append
148 -- , append
@@ -153,13 +154,13 @@ module Streamly.Data.Stream.Concurrent
153 -- , zipWithM
154 -- , zipWithM
154 -- , zipWith
155 -- , zipWith
155
156
156− -- ** Stream of streams
157+ -- *** Stream of streams
157− -- *** Apply
158+ -- **** Apply
158
159
159 -- , apply
160 -- , apply
160 , parApply
161 , parApply
161
162
162− -- *** Concat
163+ -- **** Concat
163 -- | Shares a single channel across many streams.
164 -- | Shares a single channel across many streams.
164
165
165 -- , concat
166 -- , concat
src/Streamly/Data/Stream/Exception.hs+1
@@ -13,6 +13,7 @@
13--
13--
14module Streamly.Data.Stream.Exception
14module Streamly.Data.Stream.Exception
15 (
15 (
16+ -- * Lifted Exceptions
16 after
17 after
17 , bracket
18 , bracket
18 -- , bracket3
19 -- , bracket3
src/Streamly/Data/Stream/Prelude.hs+1−7
@@ -13,12 +13,8 @@
13module Streamly.Data.Stream.Prelude
13module Streamly.Data.Stream.Prelude
14 ( module Streamly.Data.Stream
14 ( module Streamly.Data.Stream
15 , module Streamly.Data.Stream.Concurrent
15 , module Streamly.Data.Stream.Concurrent
16− , module Streamly.Data.Stream.Exception
17 , module Streamly.Data.Stream.Time
16 , module Streamly.Data.Stream.Time
18− , liftInner
19− , runReaderT
20− , runStateT
21− -- , module Streamly.Internal.Data.Stream.Extra
17+ , module Streamly.Data.Stream.Exception
22 )
18 )
23where
19where
24
20
@@ -26,5 +22,3 @@ import Streamly.Data.Stream
26import Streamly.Data.Stream.Concurrent
22import Streamly.Data.Stream.Concurrent
27import Streamly.Data.Stream.Exception
23import Streamly.Data.Stream.Exception
28import Streamly.Data.Stream.Time
24import Streamly.Data.Stream.Time
29−import Streamly.Internal.Data.Stream.Transformer
30−import Streamly.Internal.Data.Stream.Extra
src/Streamly/Data/Stream/Time.hs+5−4
@@ -15,17 +15,18 @@
15--
15--
16module Streamly.Data.Stream.Time
16module Streamly.Data.Stream.Time
17 (
17 (
18+ -- * Time
18− -- * Timers
19+ -- ** Timers
19 interject
20 interject
20
21
21− -- * Trimming
22+ -- ** Trimming
22 , takeInterval
23 , takeInterval
23 , dropInterval
24 , dropInterval
24
25
25− -- * Chunking
26+ -- ** Chunking
26 , intervalsOf
27 , intervalsOf
27
28
28− -- * Sampling
29+ -- ** Sampling
29 , sampleIntervalEnd
30 , sampleIntervalEnd
30 , sampleIntervalStart
31 , sampleIntervalStart
31 , sampleBurstEnd
32 , sampleBurstEnd