composewell/streamly
1
1
Fork 0
mirror of https://github.com/composewell/streamly.git synced 2024-09-11 11:37:22 +03:00
Code Issues Packages Projects Releases Wiki Activity

Update Changelog.md (#1913)

Browse Source 
* Update, reorgainze, move related things together, remove redundant stuff

Co-authored-by: Harendra Kumar <harendra@composewell.com>
This commit is contained in:
Ranjeet Ranjan 2023-01-18 09:22:08 +05:30 committed by GitHub
parent 833c16a6d7
commit b4c007e839
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 53 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

71
docs/User/ProjectRelated/Changelog.md
View File

@ -3,32 +3,67 @@
<!-- See rendered changelog at https://streamly.composewell.com -->
## 0.9.0 (Unreleased)
* Remove support for GHC 8.4.*
* New modules for unboxed mutable & unboxed immutable arrays are added.
### Major Changes
`streamly` package is split into two packages, (1) `streamly-core` that
has only GHC boot library depdendecies, and (2) `streamly` that contains
higher level operations with additional dependencies.
### Breaking Changes
* Moved the following modules to the `streamly-core` package:
* Streamly.Console.Stdio
* Streamly.Data.Fold
* Streamly.Data.Unfold
* Streamly.FileSystem.Handle
* Streamly.Unicode.Stream
* The unboxed arrays now require `Unbox` instead of `Storable` for the stored
type. The `Unbox` typeclass can be found in `Streamly.Data.Array`.
* Following APIs have been renamed in Streamly.Network.Socket module:
readWithBufferOf -> readWith
readChunksWithBufferOf -> readChunksWith
writeWithBufferOf -> writeWith
writeChunksWithBufferOf -> writeChunksWith
* Signature changed: Streamly.Data.Unfold.fromStream
* Add `Streamly.Data.Stream.Concurrent` that provide combinators for handling
non-serial streams.
* Remove the MonadBase instance of the SerialT type.
* In `Streamly.Data.Unfold`, signatures changed:
* `fromStream`
* `replicateM`
### Enhancements
* Added the following new modules to the `streamly-core` package:
* Streamly.Data.Array.Mut
* Streamly.Data.Array.Generic
* Streamly.Data.Array.Generic.Mut
* Streamly.Data.Parser
* Streamly.FileSystem.Dir
* Streamly.FileSystem.File
* Streamly.Unicode.String
* Streamly.Unicode.Parser
* Added the following new modules to the `streamly` package:
* Streamly.Data.Stream.MkType
* Streamly.Data.Stream.Prelude
### Deprecations
* `Streamly.Data.Array.Foreign` renamed and moved to `Streamly.Data.Array` in
`streamly-core` package. Corresponding internal modules are renamed
accordingly.
* In `Streamly.Data.Fold`:
* `variance`, and `stdDev` have been deprecated. Please use the
* `head` renamed to `one`.
* `serialWith` renamed to `splitWith`.
* `variance`, and `stdDev` deprecated. Please use the
`streamly-statistics` package instead.
* `serialWith` is deprecated. Use `splitWith` instead.
* `Streamly.Data.Array.Foreign` is deprecated. Use `Streamly.Data.Array`
instead.
* The type of `replicateM` in `Streamly.Data.Unfold` is changed.
* In `Streamly.Network.Socket`:
* `readWithBufferOf` renamed to `readWith`
* `readChunksWithBufferOf` renamed to `readChunksWith`
* `writeWithBufferOf` renamed to `writeWith`
* `writeChunksWithBufferOf` renamed to `writeChunksWith`
* Remove support for GHC 8.4.*
### Internal module changes
If you cannot find an internal module that you were using, it may have
been moved to the `streamly-core` package or may have been renamed.
Following modules are moved to `streamly-core` package and renamed:
* Streamly.Internal.Data.Array.Stream.Foreign -> Streamly.Internal.Data.Stream.Chunked
* Streamly.Internal.Data.Array.Stream.Mut.Foreign -> Streamly.Internal.Data.Array.Mut.Stream
## 0.8.2 (Mar 2022)