streamly-bytestring: Library for streamly and bytestring interoperation.

[ bsd3, bytestring, library, stream, streamly ] [ Propose Tags ]

Downloads

Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees

Candidates

Versions [RSS] 0.1.0.0, 0.1.0.1, 0.1.1, 0.1.2, 0.1.3, 0.1.4, 0.2.0, 0.2.1 (info)
Change log Changelog.md
Dependencies base (>=4.7 && <5), bytestring (>=0.11.0 && <0.11.3 || >=0.11.3.1 && <0.11.6 || >=0.12.0 && <0.12.1), streamly-core (>=0.1.0 && <0.2.2) [details]
License BSD-3-Clause
Copyright Sibi Prabakaran
Author Sibi Prabakaran
Maintainer sibi@psibi.in
Category Streamly, Stream, ByteString
Home page https://github.com/psibi/streamly-bytestring#readme
Bug tracker https://github.com/psibi/streamly-bytestring/issues
Source repo head: git clone https://github.com/psibi/streamly-bytestring
Uploaded by adithyaov at 2024-01-03T12:18:19Z
Distributions NixOS:0.2.0, Stackage:0.2.1
Reverse Dependencies 11 direct, 5 indirect [details]
Downloads 2651 total (44 in the last 30 days)
Rating 2.5 (votes: 3) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs available [build log]
Last success reported on 2024-01-03 [all 1 reports]

Readme for streamly-bytestring-0.2.1

[back to package description]

streamly-bytestring

Library for streamly and bytestring interoperation.

If you are writing code from scratch, please use Streamly.Data.Array which is a generalization of ByteString and better integrated with streamly.

This library is to enable interoperation of streamly with existing code that uses ByteString.

The package provides APIs to interconvert between strict Bytestring and streamly Array Word8 and between lazy Bytestring and stream of Array Word8.

The interconversion in the case of strict Bytestring and streamly Array Word8 has no overhead for GHC allocated memory. For foreign allocator allocated memory there is a copy involved.

Usage

This is a dumb program that counts the number of bytes in a file.

import qualified Streamly.Data.Stream as S
import qualified Streamly.Data.Fold as FL

import qualified Data.ByteString as BS
import qualified Data.ByteString.Lazy as BSL

import qualified Streamly.External.ByteString as Strict
import qualified Streamly.External.ByteString.Lazy as Lazy

import System.IO (FilePath)

strictByteStringSize :: BS.ByteString -> IO Int
strictByteStringSize bs = S.fold FL.length $ S.unfold Strict.reader bs

lazyByteStringSize :: BSL.ByteString -> IO Int
lazyByteStringSize bsl =
    S.fold (FL.foldl' (+) 0)
        $ S.mapM strictByteStringSize
        $ fmap Strict.fromArray
        $ Lazy.toChunks bsl

fileSize :: FilePath -> IO Int
fileSize path = do
    bsl <- BSL.readFile path
    lazyByteStringSize bsl