Community
Modules 50

Data.Text.Internal.Lazy

License : BSD-style Maintainer : bos@serpentine.com Stability : experimental Portability : GHC

Warning: this is an internal module, and does not have a stable API or name. Functions in this module may not check or enforce preconditions expected by public modules. Use at your own risk!

A module containing private Text internals. This exposes the Text representation and low level construction functions. Modules which extend the Text system may need to use this module.

data Text

Empty :: Text

Empty text.

Chunk :: T.Text -> Text -> Text

Text

Chunks must be non-empty, this invariant is not checked.

type LazyText = Text

Type synonym for the lazy flavour of Text.

chunk :: T.Text -> Text -> Text

Smart constructor for Chunk. Guarantees the data type invariant.

empty :: Text

Smart constructor for Empty.

foldrChunks :: (T.Text -> a -> a) -> a -> Text -> a

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

foldlChunks :: (a -> T.Text -> a) -> a -> Text -> a

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

Data type invariant and abstraction functions

The data type invariant for lazy Text: Every Text is either Empty or consists of non-null Texts. All functions must preserve this, and the QC properties must check this.

showStructure :: Text -> String

Display the internal structure of a lazy Text.

Chunk allocation sizes

defaultChunkSize :: Int

Currently set to 16 KiB, less the memory management overhead.

smallChunkSize :: Int

Currently set to 128 bytes, less the memory management overhead.

chunkOverhead :: Int

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

equal :: Text -> Text -> Bool

Copyright
(c) 2009, 2010 Bryan O'Sullivan
Build record and source files

Community contribution. The service has not verified this documentation. The generator reported 2 diagnostics.

Target: Linux on x86-64. Some inferred types and resolved links are not available.

Generator: aihc-haddock-858b1951-web-1

Metadata snapshot: 0b0724abd14577f7a6c8172d62e3e1c0808feb114d4d379402e17f37e3c7801e

Open the dependency plan · Download the documentation model

Import a package

Enter a package name and an exact version from Hackage. The site contains imported versions only.