Copyright	(c) Don Stewart 2006-2008 (c) Duncan Coutts 2006-2011
License	BSD-style
Maintainer	[email protected], [email protected]
Stability	unstable
Portability	non-portable
Safe Haskell	Unsafe
Language	Haskell2010

The lazy ByteString type and representation

data ByteString Source

A space-efficient representation of a Word8 vector, supporting many efficient operations.

A LazyByteString contains 8-bit bytes, or by using the operations from Data.ByteString.Lazy.Char8 it can be interpreted as containing 8-bit characters.

type LazyByteString = ByteString Source

Type synonym for the lazy flavour of ByteString.

Since: bytestring-0.11.2.0

chunk :: StrictByteString -> ByteString -> ByteString Source

Smart constructor for Chunk. Guarantees the data type invariant.

foldrChunks :: (StrictByteString -> a -> a) -> a -> ByteString -> a Source

Consume the chunks of a lazy ByteString with a natural right fold.

foldlChunks :: (a -> StrictByteString -> a) -> a -> ByteString -> a Source

Consume the chunks of a lazy ByteString with a strict, tail-recursive, accumulating left fold.

Data type invariant and abstraction function

invariant :: ByteString -> Bool Source

The data type invariant: Every ByteString is either Empty or consists of non-null StrictByteStrings. All functions must preserve this.

checkInvariant :: ByteString -> ByteString Source

Lazily checks that the given ByteString satisfies the data type's "no empty chunks" invariant, raising an exception in place of the first chunk that does not satisfy the invariant.

Chunk allocation sizes

defaultChunkSize :: Int Source

The chunk size used for I/O. Currently set to 32k, less the memory management overhead

smallChunkSize :: Int Source

The recommended chunk size. Currently set to 4k, less the memory management overhead

chunkOverhead :: Int Source

The memory management overhead. Currently this is tuned for GHC only.

Conversion with lists: packing and unpacking

packBytes :: [Word8] -> ByteString Source

packChars :: [Char] -> ByteString Source

unpackBytes :: ByteString -> [Word8] Source

unpackChars :: ByteString -> [Char] Source

Conversions with strict ByteString

fromStrict :: StrictByteString -> LazyByteString Source

O(1) Convert a StrictByteString into a LazyByteString.

toStrict :: LazyByteString -> StrictByteString Source

O(n) Convert a LazyByteString into a StrictByteString.

Note that this is an expensive operation that forces the whole LazyByteString into memory and then copies all the data. If possible, try to avoid converting back and forth between strict and lazy bytestrings.