e6cc89b · streamly · git.iko.soy

git.iko.soy/streamly

on master help sign in

Make some minor changes to Stream.Prelude docs

e6cc89bHarendra Kumar3 years ago

src/Streamly/Data/Stream/Concurrent.hs+7−6

compare with master

unifiedsplit

@@ -17,8 +17,9 @@

18module Streamly.Data.Stream.Concurrent

19 (

20− -- * Concurrency

21 -- $concurrency

20 -- $concurrency

21+

22+ -- ** Types

22 MonadAsync

23 MonadAsync

24 -- ** Configuration

25 -- ** Configuration

@@ -110,7 +111,7 @@ import Prelude hiding (mapM, sequence, concat, concatMap, zipWith)

110

111

111-- $concurrency

112-- $concurrency

112--

113--

113−-- == Concurrency Channels

114+-- == Channels

114--

115--

115-- At a lower level, concurrency is implemented using channels that support

116-- At a lower level, concurrency is implemented using channels that support

116-- concurrent evaluation of streams. We create a channel, and add one or more

117-- concurrent evaluation of streams. We create a channel, and add one or more

@@ -118,7 +119,7 @@ import Prelude hiding (mapM, sequence, concat, concatMap, zipWith)

118-- generates a single output stream from the results. How the streams are

119-- generates a single output stream from the results. How the streams are

119-- combined depends on the configuration of the channel.

120-- combined depends on the configuration of the channel.

120--

121--

121−-- == Concurrency Primitives

122+-- == Primitives

122--

123--

123-- There are only a few fundamental abstractions for concurrency, 'parEval',

124-- There are only a few fundamental abstractions for concurrency, 'parEval',

124-- 'parConcatMap', and 'parConcatIterate', all concurrency combinators can be

125-- 'parConcatMap', and 'parConcatIterate', all concurrency combinators can be

@@ -139,7 +140,7 @@ import Prelude hiding (mapM, sequence, concat, concatMap, zipWith)

139-- function recursively over the stream. This can be used to traverse trees or

140-- function recursively over the stream. This can be used to traverse trees or

140-- graphs.

141-- graphs.

141--

142--

142−-- == Concurrency Configuration

143+-- == Configuration

143--

144--

144-- Concurrent combinators take a 'Config' argument which controls the

145-- Concurrent combinators take a 'Config' argument which controls the

145-- concurrent behavior. For example, maximum number of threads to be used

146-- concurrent behavior. For example, maximum number of threads to be used

@@ -158,7 +159,7 @@ import Prelude hiding (mapM, sequence, concat, concatMap, zipWith)

158-- documentation for the default behavior and default values of configuration

159-- documentation for the default behavior and default values of configuration

159-- parameters.

160-- parameters.

160--

161--

161−-- == Scheduling behavior

162+-- == Scheduling

162--

163--

163-- The most important configuration option is to control whether the output of

164-- The most important configuration option is to control whether the output of

164-- the concurrent execution is consumed in the same order as the corresponding

165-- the concurrent execution is consumed in the same order as the corresponding

@@ -174,7 +175,7 @@ import Prelude hiding (mapM, sequence, concat, concatMap, zipWith)

174-- if the stream consumer thread blocks it does not make any impact on the

175-- if the stream consumer thread blocks it does not make any impact on the

175-- scheduling of the available tasks.

176-- scheduling of the available tasks.

176--

177--

177−-- == Concurrent Combinators

178+-- == Combinators

178--

179--

179-- Using the few fundamental concurrency primitives we can implement all the

180-- Using the few fundamental concurrency primitives we can implement all the

180-- usual streaming combinators with concurrent behavior. Combinators like

181-- usual streaming combinators with concurrent behavior. Combinators like

src/Streamly/Data/Stream/Exception.hs−1

@@ -13,7 +13,6 @@

13--

14module Streamly.Data.Stream.Exception

15 (

16− -- * Lifted Exceptions

17 after

16 after

18 , bracket

17 , bracket

19 -- , bracket3

18 -- , bracket3

src/Streamly/Data/Stream/Prelude.hs+18−10

@@ -6,20 +6,28 @@

6-- Stability : experimental

7-- Portability : GHC

8--

9−-- This module re-exports the "Streamly.Data.Stream" module from the

9+-- All Stream related combinators including the streamly-core

10−-- "streamly-core" package and additionally provides concurrency, time and

10+-- "Streamly.Data.Stream" module, concurrency, time and lifted

11−-- lifted exception operations as well in a single module.

11+-- exception operations.

12−--

13−-- Also see the following modules for more pre-release operations:

14−--

15−-- * "Streamly.Internal.Data.Stream.Concurrent"

16−-- * "Streamly.Internal.Data.Stream.Time"

17−-- * "Streamly.Internal.Data.Stream.Exception.Lifted"

18--

12--

19module Streamly.Data.Stream.Prelude

13module Streamly.Data.Stream.Prelude

14+ (

15+ -- * "Streamly.Data.Stream"

16+ -- | All "Streamly.Data.Stream" combinators are re-exported via this

17+ -- module. For more pre-release combinators also see

18+ -- "Streamly.Internal.Data.Stream" module.

19+ module Streamly.Data.Stream

20+ -- * Concurrent Operations

20− ( module Streamly.Data.Stream

21+ -- | Also see "Streamly.Internal.Data.Stream.Concurrent" for more

22+ -- pre-release functions.

21 , module Streamly.Data.Stream.Concurrent

23 , module Streamly.Data.Stream.Concurrent

24+ -- * Time Related

25+ -- | Also see "Streamly.Internal.Data.Stream.Time" for more pre-release

26+ -- functions.

22 , module Streamly.Data.Stream.Time

27 , module Streamly.Data.Stream.Time

28+ -- * Lifted Exceptions

29+ -- | Also see "Streamly.Internal.Data.Stream.Exception.Lifted" for more

30+ -- pre-release functions.

23 , module Streamly.Data.Stream.Exception

31 , module Streamly.Data.Stream.Exception

24 )

32 )

25where

33where

src/Streamly/Data/Stream/Time.hs−1

@@ -15,7 +15,6 @@

15--

16module Streamly.Data.Stream.Time

17 (

18− -- * Time

19 -- ** Timers

18 -- ** Timers

20 interject

19 interject