Documentation

Thin wrapper over Buffer with a handy Semigroup instance.

>>> :set -XOverloadedStrings -XMagicHash
>>> fromText "foo" <> fromChar '_' <> fromAddr "bar"#
"foo_bar"

Remember: this is a strict builder, so on contrary to Data.Text.Lazy.Builder for optimal performance you should use strict left folds instead of lazy right ones.

Note that (similar to other builders) concatenation of Builders allocates thunks. This is to a certain extent mitigated by aggressive inlining, but it is faster to use Buffer directly.

Run Builder computation on an empty Buffer, returning strict Text.

>>> :set -XOverloadedStrings -XMagicHash
>>> runBuilder (fromText "foo" <> fromChar '_' <> fromAddr "bar"#)
"foo_bar"

This function has a polymorphic arrow and thus can be used both in usual and linear contexts.

Same as runBuilder, but returning a UTF-8 encoded strict ByteString.

Create Builder, containing a given Text.

>>> :set -XOverloadedStrings
>>> fromText "foo" <> fromText "bar"
"foobar"

Create Builder, containing a given Char.

>>> fromChar 'x' <> fromChar 'y'
"xy"

In contrast to singleton, it's a responsibility of the caller to sanitize surrogate code points with safe.

Create Builder, containing a null-terminated UTF-8 string, specified by Addr#.

>>> :set -XMagicHash
>>> fromAddr "foo"# <> fromAddr "bar"#
"foobar"

The literal string must not contain zero bytes \0 and must be a valid UTF-8, these conditions are not checked.

Create Builder, containing decimal representation of a given integer.

>>> fromChar 'x' <> fromDec (123 :: Int)
"x123"

Create Builder, containing hexadecimal representation of a given integer.

>>> :set -XMagicHash
>>> fromAddr "0x"# <> fromHex (0x123def :: Int)
"0x123def"

Create Builder, containing decimal representation of a given Double.

>>> :set -XMagicHash
>>> fromAddr "pi="# <> fromDouble pi
"pi=3.141592653589793"