HORIZON HASKELLDocslts/ghc-9.10.xc74966e2026-09-27Search names, modules, packages, or :: a typeCtrl K

GHC 9.10.3 · lts/ghc-9.10.x · c74966e · 2026-09-27

Moduletext-2.1.3Haskell2010

Data.Text.Internal.Builder

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!

Efficient construction of lazy Text values. The principal operations on a Builder are singleton, fromText, and fromLazyText, which construct new builders, and mappend, which concatenates two builders.

To get maximum performance when building lazy Text values using a builder, associate mappend calls to the right. For example, prefer

singleton 'a' `mappend` (singleton 'b' `mappend` singleton 'c')

to

singleton 'a' `mappend` singleton 'b' `mappend` singleton 'c'

as the latter associates mappend to the left.

  • 2 types
  • 10 values
  • Packagetext-2.1.3
  • Exports12
  • LanguageHaskell2010
  • LicenceBSD-2-Clause
  • SourceBuilder.hs

Public API

0 declarations

The Builder type

newtypenewtype Builder
#

A Builder is an efficient way to build lazy Text values. There are several functions for constructing builders, but only one to inspect them: to extract any data, you have to turn them into lazy Text values using toLazyText.

Internally, a builder constructs a lazy Text by filling arrays piece by piece. As each buffer is filled, it is 'popped' off, to become a new chunk of the resulting lazy Text. All this is hidden from the user of the Builder.

Instances6Eq, Ord, Show, IsString, Semigroup, Monoid
  • Eq BuilderDefined in text-2.1.3 · Data.Text.Internal.Builder
  • Ord BuilderDefined in text-2.1.3 · Data.Text.Internal.Builder
  • Show BuilderDefined in text-2.1.3 · Data.Text.Internal.Builder
  • IsString BuilderDefined in text-2.1.3 · Data.Text.Internal.Builder

    Performs replacement on invalid scalar values:

    Example2 expressions
    :set -XOverloadedStrings"\55555" :: Builder"\65533"
  • Semigroup BuilderDefined in text-2.1.3 · Data.Text.Internal.Builder
  • Monoid BuilderDefined in text-2.1.3 · Data.Text.Internal.Builder
valuetoLazyText :: Builder -> Text
#

O(n). Extract a lazy Text from a Builder with a default buffer size. The construction work takes place if and when the relevant part of the lazy Text is demanded.

valuetoLazyTextWith :: Int -> Builder -> Text
#

O(n). Extract a lazy Text from a Builder, using the given size for the initial buffer. The construction work takes place if and when the relevant part of the lazy Text is demanded.

If the initial buffer is too small to hold all data, subsequent buffers will be the default buffer size.

Constructing Builders

Flushing the buffer state

valueflush :: Builder
#

O(1). Pop the strict Text we have constructed so far, if any, yielding a new chunk in the result lazy Text.

Internal functions

3 declarations
valuewriteN :: Int -> (forall s. MArray s -> Int -> ST s ()) -> Builder
#

Ensure that n many elements are available, and then use f to write some elements into the memory.