@@ -3,15 +3,40 @@
3### Breaking changes
3### Breaking changes
5* Change the signature of `foldrM` to ensure that it is lazy
5* Change the signature of `foldrM` to ensure that it is lazy
6−* `scanx` would now require an additional `Monad m` constraint.
7* Change the signature of `iterateM` to ensure that it is lazy.
6* Change the signature of `iterateM` to ensure that it is lazy.
7+* `scanx` would now require an additional `Monad m` constraint.
8−* Earlier ParallelT was unaffected by `maxBuffer` directive, now `maxBuffer`
11+* Earlier `ParallelT` was unaffected by `maxBuffer` directive, now `maxBuffer`
9− can limit the buffer of a ParallelT stream as well. When the buffer becomes
12+ can limit the buffer of a `ParallelT` stream as well. When the buffer becomes
10− full the producer threads block.
13+ full, the producer threads block.
11−* ParallelT streams no longer have an unlimited buffer by default. Now the
14+* `ParallelT` streams no longer have an unlimited buffer by default. Now the
12 buffer for parallel streams is limited to 1500 by default, the same as other
15 buffer for parallel streams is limited to 1500 by default, the same as other
13 concurrent stream types.
16 concurrent stream types.
20+* In `Streamly.Prelude`:
21+ * `runStream` has been replaced by `drain`
22+ * `runN` has been replaced by `drainN`
23+ * `runWhile` has been replaced by `drainWhile`
24+ * `fromHandle` has been deprecated. Please use
25+ `Streamly.FileSystem.Handle.read`, `Streamly.String.decodeUtf8` and
26+ `Streamly.String.lines` to split the stream into lines. Use
27+ `Streamly.String.foldLine` with `Streamly.Fold.toList` if you want to
28+ convert the stream to a stream of `String`.
29+ * `toHandle` has been deprecated. Please use `intersperse` and `concat` to
30+ add newlines to a stream, `Streamly.String.encodeUtf8` for encoding and
31+ `Streamly.FileSystem.Handle.write` for writing to a file handle.
32+ * Deprecate `scanx`, `foldx`, `foldxM`, `foldr1`
33+ * Remove deprecated APIs `scan`, `foldl`, `foldlM`
35+* In `Streamly` module:
36+ * `runStream` has been deprecated, please use `Streamly.Prelude.drain`
37+ * `foldWith`, `foldMapWith`, `forEachWith` have been moved to
38+ `Streamly.Prelude` module.
15### Bug Fixes
40### Bug Fixes
17* Fix a bug that caused `uniq` function to yield the same element twice.
42* Fix a bug that caused `uniq` function to yield the same element twice.
@@ -70,19 +95,6 @@ example, concat streams concurrently using this.
70 * `tap` redirects a copy of the stream to a `Fold`
95 * `tap` redirects a copy of the stream to a `Fold`
71 * `tee` redirects a copy of the stream to a concurrent fold function
96 * `tee` redirects a copy of the stream to a concurrent fold function
75−* `runStream` has been replaced by `Streamly.Prelude.drain`
76−* `runN` has been replaced by `drainN`
77−* `runWhile` has been replaced by `drainWhile`
79−* `foldWith`, `foldMapWith`, `forEachWith` have been deprecated in "Streamly"
80− module and moved to "Streamly.Prelude" module.
82−* In "Streamly.Prelude":
83− * Deprecate `scanx`, `foldx`, `foldxM`, `foldr1`
84− * Remove deprecated APIs `scan`, `foldl`, `foldlM`
88### Bug Fixes
100### Bug Fixes