ebe2472 · streamly · git.iko.soy

git.iko.soy/streamly

Expose doctest setup for StreamK module

commitebe2472176d97bd6d6a494d517f0a659246f5dab authorHarendra Kumar <harendra@composewell.com> dateSun 12 Mar 2023, 13:46 (4 years ago) parentfe3609b

5 files changed+29−20

compare with master

unifiedsplit

core/src/DocTestDataStreamK.hs+18 core/src/Streamly/Data/StreamK.hs+3 core/src/Streamly/Internal/Data/Stream/StreamK.hs+2−8 core/src/Streamly/Internal/Data/Stream/StreamK/Type.hs+5−12 core/streamly-core.cabal+1

core/src/DocTestDataStreamK.hsnew file+18

@@ -0,0 +1,18 @@

1+{- $setup

3+>>> :m

4+>>> import Data.Function (fix, (&))

5+>>> import Data.Semigroup (cycle1)

7+>>> import Streamly.Data.StreamK (StreamK)

8+>>> import qualified Streamly.Data.Fold as Fold

9+>>> import qualified Streamly.Data.Parser as Parser

10+>>> import qualified Streamly.Data.Stream as Stream

11+>>> import qualified Streamly.Data.StreamK as StreamK

12+>>> import qualified Streamly.FileSystem.Dir as Dir

13+

14+For APIs that have not been released yet.

15+

16+>>> import qualified Streamly.Internal.Data.Stream.StreamK as StreamK

17+>>> import qualified Streamly.Internal.FileSystem.Dir as Dir

18+-}

core/src/Streamly/Data/StreamK.hs+3

@@ -1,3 +1,4 @@

1+{-# LANGUAGE CPP #-}

12-- |

23-- Module : Streamly.Data.StreamK

@@ -119,3 +120,5 @@ where

119120

120121import Streamly.Internal.Data.Stream.StreamK

121122import Prelude hiding (reverse, zipWith, mapM, dropWhile, take)

123+

124+#include "DocTestDataStreamK.hs"

core/src/Streamly/Internal/Data/Stream/StreamK.hs+2−8

@@ -1,3 +1,4 @@

1+{-# LANGUAGE CPP #-}

12-- |

23-- Module : Streamly.Internal.Data.Stream.StreamK

@@ -252,14 +253,7 @@ import Prelude

252253import Streamly.Internal.Data.Stream.StreamK.Type

253254import Streamly.Internal.Data.Parser.ParserD (ParseError(..))

254255

255−-- $setup

256−-- >>> :m

257−-- >>> import qualified Streamly.Data.Fold as Fold

258−-- >>> import qualified Streamly.Data.Parser as Parser

259−-- >>> import qualified Streamly.Data.Stream as Stream

260−-- >>> import qualified Streamly.Data.StreamK as StreamK

261−-- >>> import qualified Streamly.Internal.Data.Stream.StreamK as StreamK

262−--

256+#include "DocTestDataStreamK.hs"

263257

264258{-# INLINE fromStream #-}

265259fromStream :: Monad m => Stream.Stream m a -> StreamK m a

core/src/Streamly/Internal/Data/Stream/StreamK/Type.hs+5−12

@@ -1,3 +1,4 @@

1+{-# LANGUAGE CPP #-}

12{-# LANGUAGE UndecidableInstances #-}

23-- |

34-- Module : Streamly.Internal.Data.Stream.StreamK.Type

@@ -163,15 +164,7 @@ import qualified Prelude

163164import Prelude hiding

164165 (map, mapM, concatMap, foldr, repeat, null, reverse, tail, init)

165166

166−-- $setup

167−-- >>> import Data.Function (fix, (&))

168−-- >>> import Data.Semigroup (cycle1)

169−-- >>> import Streamly.Internal.Data.Stream.StreamK (CrossStreamK(..))

170−-- >>> import qualified Streamly.Data.Fold as Fold

171−-- >>> import qualified Streamly.Data.Stream as Stream

172−-- >>> import qualified Streamly.Data.StreamK as StreamK

173−-- >>> import qualified Streamly.Internal.Data.Stream.StreamK as StreamK

174−-- >>> import qualified Streamly.Internal.FileSystem.Dir as Dir

167+#include "DocTestDataStreamK.hs"

175168

176169------------------------------------------------------------------------------

177170-- Basic stream type

@@ -315,7 +308,7 @@ nilM m = mkStream $ \_ _ _ stp -> m *> stp

315308

316309-- | Create a singleton stream from a pure value.

317310--

318−-- >>> fromPure a = a `cons` StreamK.nil

311+-- >>> fromPure a = a `StreamK.cons` StreamK.nil

319312-- >>> fromPure = pure

320313-- >>> fromPure = StreamK.fromEffect . pure

321314--

@@ -325,7 +318,7 @@ fromPure a = mkStream $ \_ _ single _ -> single a

325318

326319-- | Create a singleton stream from a monadic action.

327320--

328−-- >>> fromEffect m = m `consM` StreamK.nil

321+-- >>> fromEffect m = m `StreamK.consM` StreamK.nil

329322--

330323-- >>> Stream.fold Fold.drain $ StreamK.toStream $ StreamK.fromEffect (putStrLn "hello")

331324-- hello

@@ -343,7 +336,7 @@ infixr 5 `consM`

343336-- | A right associative prepend operation to add an effectful value at the

344337-- head of an existing stream::

345338--

346−-- >>> s = putStrLn "hello" `consM` putStrLn "world" `consM` StreamK.nil

339+-- >>> s = putStrLn "hello" `StreamK.consM` putStrLn "world" `StreamK.consM` StreamK.nil

347340-- >>> Stream.fold Fold.drain (StreamK.toStream s)

348341-- hello

349342-- world

core/streamly-core.cabal+1

@@ -44,6 +44,7 @@ extra-source-files:

4444 src/DocTestDataMutArrayGeneric.hs

4545 src/DocTestDataParser.hs

4646 src/DocTestDataStream.hs

47+ src/DocTestDataStreamK.hs

4748

4849 -- This is duplicated

4950 src/Streamly/Internal/Data/Array/ArrayMacros.h