 | bytestring-0.9.0.1: Fast, packed, strict and lazy byte arrays with a list interface | Contents | Index |
|
| Data.ByteString.Lazy.Internal | | Portability | portable | | Stability | experimental | | Maintainer | dons@cse.unsw.edu.au, duncan@haskell.org |
|
|
|
|
|
| Description |
| A module containing semi-public ByteString internals. This exposes
the ByteString representation and low level construction functions.
Modules which extend the ByteString system will need to use this module
while ideally most users will be able to make do with the public interface
modules.
|
|
| Synopsis |
|
|
|
|
| The lazy ByteString type and representation
|
|
| data ByteString |
A space-efficient representation of a Word8 vector, supporting many
efficient operations. A ByteString contains 8-bit characters only.
Instances of Eq, Ord, Read, Show, Data, Typeable
| | Constructors | |  Instances | |
|
|
| chunk :: ByteString -> ByteString -> ByteString |
| Smart constructor for Chunk. Guarantees the data type invariant.
|
|
| foldrChunks :: (ByteString -> a -> a) -> a -> ByteString -> a |
| Consume the chunks of a lazy ByteString with a natural right fold.
|
|
| foldlChunks :: (a -> ByteString -> a) -> a -> ByteString -> a |
| Consume the chunks of a lazy ByteString with a strict, tail-recursive,
accumulating left fold.
|
|
| Data type invariant and abstraction function
|
|
| invariant :: ByteString -> Bool |
| The data type invariant:
Every ByteString is either Empty or consists of non-null ByteStrings.
All functions must preserve this, and the QC properties must check this.
|
|
| checkInvariant :: ByteString -> ByteString |
| In a form that checks the invariant lazily.
|
|
| Chunk allocation sizes
|
|
| defaultChunkSize :: Int |
| Currently set to 32k, less the memory management overhead
|
|
| smallChunkSize :: Int |
| Currently set to 4k, less the memory management overhead
|
|
| chunkOverhead :: Int |
| The memory management overhead. Currently this is tuned for GHC only.
|
|
| Produced by Haddock version 0.8 |