@@ -1,6 +1,6 @@
1## Unreleased
1## Unreleased
3−### Behavioral changes
3+### Breaking behavior changes
5* `Streamly.Prelude.fold` may now terminate early without consuming the entire
5* `Streamly.Prelude.fold` may now terminate early without consuming the entire
6 stream. For example, `fold Fold.head stream` would now terminate immediately
6 stream. For example, `fold Fold.head stream` would now terminate immediately
@@ -15,11 +15,11 @@
15* `encodeLatin1` now silently truncates any character beyond 255 to incorrect
15* `encodeLatin1` now silently truncates any character beyond 255 to incorrect
16 characters in the input stream. Use `encodeLatin1'` to recover previous
16 characters in the input stream. Use `encodeLatin1'` to recover previous
17 functionality.
17 functionality.
18−* The zipping function in `Streamly.Prelude.zipWith` and
18+* The zipping functions `Streamly.Prelude.zipWith` and
19− `Streamly.Prelude.zipWithM` is now applied concurrently for concurrent
19+ `Streamly.Prelude.zipWithM` are now applied concurrently for concurrent
22−### Breaking changes
22+### Breaking type changes
24* Change the signature of `foldlM'` to make the initial value of the
24* Change the signature of `foldlM'` to make the initial value of the
25 accumulator monadic.
25 accumulator monadic.
@@ -31,39 +31,59 @@
31 require an additional `MonadAsync` constraint. Several other
31 require an additional `MonadAsync` constraint. Several other
32 functions that used these functions also now require the additional
32 functions that used these functions also now require the additional
33 constraint.
33 constraint.
34−* Remove `Applicative` instance of folds. Please use `teeWith` or the `Tee`
35− type as an alternative to Fold applicative. To convert existing code:
37− ```
35+Removed `Applicative` instance of folds. Please use `teeWith` or the `Tee`
36+type as an alternative to Fold applicative.
38+To upgrade, the following code:
38− avg = (/) <$> Fold.sum <*> Fold.length
41+ avg = (/) <$> Fold.sum <*> Fold.length
41− Would become:
44+can be changed to:
44− import Streamly.Internal.Data.Fold.Tee (Tee(..))
47+ import Streamly.Internal.Data.Fold.Tee (Tee(..))
45− import qualified Streamly.Internal.Data.Fold.Tee as Tee
48+ import qualified Streamly.Internal.Data.Fold.Tee as Tee
46− avg = Tee.toFold $ (/) <$> Tee Fold.sum <*> Tee Fold.length
49+ avg = Tee.toFold $ (/) <$> Tee Fold.sum <*> Tee Fold.length
49− Or
52+or alternatively to:
52− avg = Fold.teeWith (/) Fold.sum Fold.length
55+ avg = Fold.teeWith (/) Fold.sum Fold.length
55### Enhancements
58### Enhancements
62+* Streamly.Console.Stdio
63+* Streamly.Data.Fold.Tee
67+* `Streamly.Data.Fold`: Many APIs added.
68+* `Streamly.Data.Unfold`: Many APIs added.
57−* `Streamly.Prelude`: Added delay, liftInner, runStateT, runReaderT,
69+* `Streamly.Prelude`:
58− intercalate, intercalateSuffix
70+ * delay
59−* `Streamly.Unicode.Stream`: New encoding/decoding routines,
78+* `Streamly.Unicode.Stream`:
60− `encodeUtf8'`, `encodeLatin1'`, `decodeUtf8'`, are added, these routines
79+ * encodeUtf8'
61− fail when they encounter any invalid characters.
80+ * encodeLatin1'
62−* `Streamly.Data.Fold`: Several new functions added.
81+ * decodeUtf8'
63−* `Streamly.Data.Fold.Tee`: New module for distributive fold operations.
64−* `Streamly.Data.Unfold`: Several Unfold routines and combinators added.
65−* Streamly.Network.Socket: Added readChunk, writeChunk,
82+* `Streamly.Network.Socket`:
66− writeChunksWithBufferOf, forSocketM
85+ * writeChunksWithBufferOf
68### Bug Fixes
88### Bug Fixes
@@ -79,48 +99,64 @@
80### Deprecations
100### Deprecations
82−* Deprecate `Streamly.Memory.Array` in favor of
102+Modules renamed:
104+* `Streamly` => Streamly.Prelude`
105+* `Streamly.Data.Unicode.Stream` => `Streamly.Unicode.Stream`
83− `Streamly.Data.Array.Foreign`
106+* `Streamly.Memory.Array` => `Streamly.Data.Array.Foreign`
84−* Deprecate `Streamly.Data.Unicode.Stream` in favor of
107+
85− `Streamly.Unicode.Stream`
108+APIs renamed:
86−* The `Streamly` module is now deprecated, its functionality is subsumed
109+
87− by `Streamly.Prelude`.
110+* In `Streamly.Prelude` module (formerly in `Streamly` module):
88−* Some functions from `Streamly` module have been renamed in `Streamly.Prelude` module:
89− * `foldWith` to `concatFoldableWith`
111+ * `foldWith` => `concatFoldableWith`
90− * `foldMapWith` to `concatMapFoldableWith`
112+ * `foldMapWith` => `concatMapFoldableWith`
91− * `forEachWith` to `concatForFoldableWith`
113+ * `forEachWith` => `concatForFoldableWith`
92− * `serially` to `fromSerial` and so on
114+ * `serially` => `fromSerial` and so on
93−* In `Streamly.Prelude` the following functions have been renamed:
115+* In `Streamly.Prelude`:
94− * `concatUnfold` to `unfoldMany`
116+ * `concatUnfold` => `unfoldMany`
95− * `yield` to `fromPure`
117+ * `yield` => `fromPure`
96− * `yieldM` to `fromEffect`
118+ * `yieldM` => `fromEffect`
97−* The following encoding/decoding routines have been renamed:
119+* In `Streamly.Unicode.Stream` (formerly `Streamly.Data.Unicode.Stream`):
98− * `encodeUtf8Lax` to `encodeUtf8`
120+ * `encodeUtf8Lax` => `encodeUtf8`
99− * `encodeLatin1Lax` to `encodeLatin1`
121+ * `encodeLatin1Lax` => `encodeLatin1`
100− * `decodeUtf8Lenient` to `decodeUtf8`
122+ * `decodeUtf8Lenient` => `decodeUtf8`
101−* Drop support for GHC 7.10.3.
102−* The following functions in `Streamly.Data.Fold` have been deprecated:
123+* In `Streamly.Data.Fold`:
103− * `mapM` is replaced by `rmapM`
124+ * `mapM` => `rmapM`
104− * `sequence` is dprecated, please use `rmapM id` instead.
128+* `sequence`: Please use `rmapM id` instead.
106−### Internal APIs
130+### Notable Internal/Pre-release API Changes
108−* `Streamly.Internal.Prelude` renamed to `Streamly.Internal.Data.Stream.IsStream`
132+Breaking changes:
109−* Parser functionality is added via `Streamly.Internal.Data.Parser` module
133+
110−* `Streamly.Internal.Data.Binary.Decode` module added for decoding Haskell
111− values from binary data.
112−* FileSystem event notification (fsnotify/inotify) functionality added via
113− `Streamly.Internal.FileSystem.Event.*` modules.
114* The `Fold` type has changed to accomodate terminating folds.
134* The `Fold` type has changed to accomodate terminating folds.
135+* Rename: `Streamly.Internal.Prelude` => `Streamly.Internal.Data.Stream.IsStream`
136+* Several other internal modules have been renamed and refactored.
140+* `Streamly.Internal.Data.Parser`: parser combinators
141+* `Streamly.Internal.Data.Binary.Decode`: decode Haskell values from binary data.
142+* `Streamly.Internal.FileSystem.Event.*`: fsnotify/inotify
143+* `Streamly.Internal.Data.Array.Stream.Fold.Foreign`: array stream folds
115−* Added `use-c-malloc` build flag to use the c library `malloc` for array
147+* `use-c-malloc` build flag to use the c library `malloc` for array
116− allocations.
148+ allocations. This could be useful to avoid pinned memory fragmentation.
117−* A bug was fixed in the conversion of MicroSecond64 and MilliSecond64
152+* A bug was fixed in the conversion of `MicroSecond64` and `MilliSecond64`
118 (commit e5119626)
153 (commit e5119626)
119−* Bug fix: classifySessionsBy now flushes sessions at the end and terminates.
154+* Bug fix: `classifySessionsBy` now flushes sessions at the end and terminates.
121### Miscellaneous
156### Miscellaneous
158+* Drop support for GHC 7.10.3.
123−* The examples in this package are removed to a new github repo
159+* The examples in this package are moved to a new github repo
124 [streamly-examples](https://github.com/composewell/streamly-examples)
160 [streamly-examples](https://github.com/composewell/streamly-examples)
126## 0.7.3 (February 2021)
162## 0.7.3 (February 2021)