on master help sign in
Update Changelog for 0.10
commit931eafb88a1ad5be0997345205e629302bbc63fd authorHarendra Kumar <harendra@composewell.com> dateSun 26 Nov 2023, 04:06 (3 years ago) parent3f489cf
1 file changed+29−21
core/docs/Changelog.md+29−21
core/docs/Changelog.md+29−21
@@ -4,6 +4,9 @@
44
55### Breaking
66
7+See the [streamly-core-0.2.0 API Changelog](/core/docs/ApiChangelogs/0.2.0.txt)
8+for a full list of changes in this release.
9+
710* `ParserK` in `Streamly.Data.ParserK` is not implicitly specialized
811 to arrays anymore. To adapt to the new code, change `ParserK a m
912 b` to `ParserK (Array a) m b` where the `Array` type comes from
@@ -11,11 +14,34 @@
1114 `parseChunks` and `parseBreakChunks`.
1215* Changed the signature of 'Streamly.Data.Stream.handle' to make the
1316 exception handler monadic.
14−* `getIndex` signature changed in `Streamly.Data.MutArray` and
15− `Streamly.Data.MutArray.Generic`.
1617* Behavior change: Exceptions are now rethrown promptly in `bracketIO`.
1718
18−### Internal Changes
19+### Enhancements
20+
21+See the [streamly-core-0.2.0 API Changelog](/core/docs/ApiChangelogs/0.2.0.txt)
22+for a full list of new APIs added in this release.
23+
24+* Serialization: Added a `Streamly.Data.MutByteArray` module with a
25+ `Serialize` type class for fast binary serialization. The Data.Array
26+ module supplies the `serialize` and `deserialize` operations for arrays.
27+* Unpinned Arrays: Unboxed arrays are now created unpinned by default,
28+ they were created pinned earlier. During IO operations, unpinned arrays
29+ are automatically copied to pinned memory. When arrays are directly
30+ passed to IO operations programmers can choose to create them pinned to
31+ avoid a copy. To create pinned arrays, use the internal APIs with the
32+ `pinned*` prefix.
33+* StreamK now supports native exception handling routines (handle, bracketIO).
34+ Earlier we had to convert it to the `Stream` type for exception handling.
35+
36+### Deprecations
37+
38+See the [streamly-core-0.2.0 API Changelog](/core/docs/ApiChangelogs/0.2.0.txt)
39+for a full list of deprecations.
40+
41+### Internal API Changes
42+
43+See the [streamly-core-0.2.0 Internal API Changelog](/core/docs/ApiChangelogs/0.2.0-internal.txt)
44+for a full list of changes to the internal modules.
1945
2046* Fold constructor has changed, added a `final` field to support
2147 finalization and cleanup of a chain of folds. The `extract` field is
@@ -30,24 +56,6 @@
3056 * Streamly.Internal.Data.Unbox is now exported via Streamly.Internal.Data.Serialize
3157 * Streamly.Internal.Data.IORef.Unboxed is now exported via Streamly.Internal.Data.Serialize
3258
33−### Enhancements
34−
35−* Unboxed arrays are now created unpinned by default, they were
36− created pinned earlier. During IO operations, unpinned arrays are
37− automatically copied to pinned memory. When arrays are directly passed
38− to IO operations programmers can choose to create them pinned to avoid a
39− copy. To create pinned arrays, use the internal APIs with the `pinned*`
40− prefix.
41−* Added a `Streamly.Data.Serialize` module for fast binary serialization.
42−* Added exception handling routines in StreamK (handle, bracketIO).
43−* More APIs added in `Streamly.Data.MutArray` and
44− `Streamly.Data.MutArray.Generic`.
45−
46−### Deprecations
47−
48−* `Streamly.Data.MutArray.newUnpinned` is renamed to
49− `Streamly.Data.MutArray.pinnedNew`
50−
5159## 0.1.0 (March 2023)
5260
5361Also see [streamly-core-0.1.0 API Changelog](/core/docs/ApiChangelogs/0.1.0.txt) or