Moduletext-2.1.3Haskell2010

Data.Text.Lazy.Builder

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')

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

as the latter associates mappend to the left. Or, equivalently, prefer

singleton 'a' <> singleton 'b' <> singleton 'c'

since the <> from recent versions of Data.Monoid associates to the right.

2 types
7 values

Packagetext-2.1.3
Exports9
LanguageHaskell2010
LicenceBSD-2-Clause
SourceBuilder.hs

The Builder type

4 declarations

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

typetype LazyTextBuilder = 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

4 declarations

valuesingleton :: Char -> Builder

O(1). A Builder taking a single character, satisfying

```
toLazyText (singleton c) = singleton c
```

valuefromText :: Text -> Builder

O(1). A Builder taking a Text, satisfying

toLazyText (fromText t) = fromChunks [t]

valuefromLazyText :: Text -> Builder

O(1). A Builder taking a lazy Text, satisfying

```
toLazyText (fromLazyText t) = t
```

valuefromString :: String -> Builder

O(1). A Builder taking a String, satisfying

toLazyText (fromString s) = fromChunks [S.pack s]

Performs replacement on invalid scalar values:

Example1 expression

>>> fromString "\55555""\65533"

Flushing the buffer state

1 declaration

valueflush :: Builder

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