streamly-core

Streaming, parsers, arrays and more

https://streamly.composewell.com

Version on this page:	0.2.0
LTS Haskell 23.21:	0.2.3
Stackage Nightly 2025-05-11:	0.2.3
Latest on Hackage:	0.2.3

See all snapshots streamly-core appears in

BSD-3-Clause licensed by Composewell Technologies

Maintained by [email protected]

This version can be pinned in stack with:streamly-core-0.2.0@sha256:73d0b5dcc1cda6b42f463d1fd69517b6a5af7a03163c1aa61aefebc454542a50,17727

Module documentation for 0.2.0

Streamly
- Streamly.Console
  - Streamly.Console.Stdio
- Streamly.Data
- Streamly.FileSystem
- Streamly.Internal
  - Streamly.Internal.BaseCompat
  - Streamly.Internal.Console
    - Streamly.Internal.Console.Stdio
  - Streamly.Internal.Control
  - Streamly.Internal.Data
    - Streamly.Internal.Data.Array
      - Streamly.Internal.Data.Array.Generic
      - Streamly.Internal.Data.Array.Stream
    - Streamly.Internal.Data.Binary
      - Streamly.Internal.Data.Binary.Parser
      - Streamly.Internal.Data.Binary.Stream
    - Streamly.Internal.Data.Builder
    - Streamly.Internal.Data.Either
      - Streamly.Internal.Data.Either.Strict
    - Streamly.Internal.Data.Fold
      - Streamly.Internal.Data.Fold.Chunked
    - Streamly.Internal.Data.IOFinalizer
    - Streamly.Internal.Data.IsMap
    - Streamly.Internal.Data.Maybe
      - Streamly.Internal.Data.Maybe.Strict
    - Streamly.Internal.Data.MutArray
      - Streamly.Internal.Data.MutArray.Generic
      - Streamly.Internal.Data.MutArray.Stream
    - Streamly.Internal.Data.MutByteArray
    - Streamly.Internal.Data.Parser
    - Streamly.Internal.Data.ParserK
    - Streamly.Internal.Data.Pipe
    - Streamly.Internal.Data.Producer
    - Streamly.Internal.Data.Refold
      - Streamly.Internal.Data.Refold.Type
    - Streamly.Internal.Data.Ring
      - Streamly.Internal.Data.Ring.Generic
    - Streamly.Internal.Data.SVar
      - Streamly.Internal.Data.SVar.Type
    - Streamly.Internal.Data.Stream
      - Streamly.Internal.Data.Stream.StreamD
    - Streamly.Internal.Data.StreamK
    - Streamly.Internal.Data.Time
      - Streamly.Internal.Data.Time.Clock
      - Streamly.Internal.Data.Time.TimeSpec
      - Streamly.Internal.Data.Time.Units
    - Streamly.Internal.Data.Tuple
      - Streamly.Internal.Data.Tuple.Strict
    - Streamly.Internal.Data.Unfold
  - Streamly.Internal.FileSystem
  - Streamly.Internal.System
    - Streamly.Internal.System.IO
  - Streamly.Internal.Unicode
- Streamly.Unicode

Depends on 13 packages(full list with versions):

base, containers, directory, exceptions, filepath, fusion-plugin-types, ghc-bignum, ghc-prim, heaps, monad-control, template-haskell, transformers, unix

Used by 1 package in lts-22.0(full list with versions):

streamly

For upgrading to streamly-0.9.0+ please read the Streamly-0.9.0 upgrade guide.

Streamly consists of two packages: "streamly-core" and "streamly". streamly-core provides basic features, and depends only on GHC boot libraries (see note below), while streamly provides higher-level features like concurrency, time, lifted exceptions, and networking. For documentation, visit the Streamly website.

This package provides streams, arrays, parsers, unicode text, file IO, and console IO functionality.

Note: The dependencies "heaps" and "monad-control" are included in the package solely for backward compatibility, and will be removed in future versions.

Changes

Changelog

0.2.0 (Nov 2023)

See 0.1.0-0.2.0 API Changelog for a full list of API changes in this release. Only a few significant changes are mentioned here.

Breaking Changes

ParserK in Streamly.Data.ParserK is not implicitly specialized to arrays anymore. To adapt to the new code, change ParserK a m b to ParserK (Array a) m b where the Array type comes from Streamly.Data.Array. This change also affected the signatures of parseChunks and parseBreakChunks.
Changed the signature of ‘Streamly.Data.Stream.handle’ to make the exception handler monadic.
Behavior change: Exceptions are now rethrown promptly in bracketIO.

Enhancements

Serialization: Added a Streamly.Data.MutByteArray module with a Serialize type class for fast binary serialization. The Data.Array module supplies the serialize and deserialize operations for arrays.
Unpinned Arrays: Unboxed arrays are now created unpinned by default, they were created pinned earlier. During IO operations, unpinned arrays are automatically copied to pinned memory. When arrays are directly passed to IO operations programmers can choose to create them pinned to avoid a copy. To create pinned arrays, use the internal APIs with the pinned* prefix.
StreamK now supports native exception handling routines (handle, bracketIO). Earlier we had to convert it to the Stream type for exception handling.

Deprecations

See 0.1.0-0.2.0 API Changelog for a full list of deprecations.

Internal API Changes

Fold constructor has changed, added a final field to support finalization and cleanup of a chain of folds. The extract field is now used only for mapping the fold internal state to fold result for scanning purposes.
Many low level internal modules have been removed, they are entirely exported from higher level internal modules. If you were importing any of the missing low level modules then import the higher level modules instead.
Internal module changes:
- Streamly.Internal.Serialize.FromBytes -> Streamly.Internal.Data.Binary.Parser
- Streamly.Internal.Serialize.ToBytes -> Streamly.Internal.Data.Binary.Stream
- Streamly.Internal.Data.Unbox is now exported via Streamly.Internal.Data.Serialize
- Streamly.Internal.Data.IORef.Unboxed is now exported via Streamly.Internal.Data.Serialize

0.1.0 (March 2023)

Also see streamly-core-0.1.0 API Changelog or https://hackage.haskell.org/package/streamly-core-0.1.0/docs/docs/ApiChangelogs/0.1.0.txt

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 (including concurrent ones) with additional dependencies.

Moved the following modules from streamly package to the streamly-core package:
- Streamly.Console.Stdio
- Streamly.Data.Fold
- Streamly.Data.Unfold
- Streamly.FileSystem.Handle
- Streamly.Unicode.Stream
Added the following new modules:
- Streamly.Data.Array
- Streamly.Data.Array.Generic
- Streamly.Data.MutArray
- Streamly.Data.MutArray.Generic
- Streamly.Data.Parser
- Streamly.Data.ParserK
- Streamly.Data.Stream
- Streamly.Data.StreamK
- Streamly.FileSystem.Dir
- Streamly.FileSystem.File
- Streamly.Unicode.Parser
- Streamly.Unicode.String