Conversion of values to Text. Because there are both strict and lazy Text variants, the TextShow class deliberately avoids using Text in its functions. Instead, showbPrec, showb, and showbList all return Builder, an efficient intermediate form that can be converted to either kind of Text.

Builder is a Monoid, so it is useful to use the mappend (or <>) function to combine Builders when creating TextShow instances. As an example:

import Data.Monoid
import TextShow

data Example = Example Int Int
instance TextShow Example where
    showb (Example i1 i2) = showb i1 <> showbSpace <> showb i2

If you do not want to create TextShow instances manually, you can alternatively use the TextShow.TH module to automatically generate default TextShow instances using Template Haskell, or the TextShow.Generic module to quickly define TextShow instances using genericShowbPrec.

Since: 2

Constructs a strict Text from a single value.

Since: 2

Constructs a lazy Text from a single value.

Since: 2

Constructs a strict Text from a single value with the given precedence.

Since: 2

Constructs a lazy Text from a single value with the given precedence.

Since: 2

Construct a strict Text from a list of values.

Since: 2

Construct a lazy Text from a list of values.

Since: 2

Surrounds Builder output with parentheses if the Bool parameter is True.

Since: 2

Construct a Builder containing a single space character.

Since: 2

Lifting of the TextShow class to unary type constructors.

Since: 2

Lift the standard showbPrec function through the type constructor.

Since: 2

showbUnaryWith sp n p x produces the Builder representation of a unary data constructor with name n and argument x, in precedence context p, using the function sp to show occurrences of the type argument.

Since: 2

Lifting of the TextShow class to binary type constructors.

Since: 2

Lift two showbPrec functions through the type constructor.

Since: 2

showbBinaryWith sp n p x y produces the Builder representation of a binary data constructor with name n and arguments x and y, in precedence context p, using the functions sp1 and sp2 to show occurrences of the type arguments.

Since: 2

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.

Convert a Builder to a strict Text.

Since: 2

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.

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.

Convert a Builder to a String (without surrounding it with double quotes, as show would).

Since: 2

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

• toLazyText (singleton c) = singleton c

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

• toLazyText (fromText t) = fromChunks [t]

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

• toLazyText (fromLazyText t) = t

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

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

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

Computes the length of a Builder.

Since: 2

Merges several Builders, separating them by newlines.

Since: 2

Merges several Builders, separating them by spaces.

Since: 2

Writes a value's strict Text representation to the standard output, followed by a newline.

Since: 2

Writes a value's lazy Text representation to the standard output, followed by a newline.

Since: 2

Writes a value's strict Text representation to a file handle, followed by a newline.

Since: 2

Writes a value's lazy Text representation to a file handle, followed by a newline.

Since: 2

The TextShow instance for FromStringShow is based on its String Show instance. That is,

showbPrec p (FromStringShow x) = showsToShowb showsPrec p x

Since: 2

The String Show instance for FromTextShow is based on its TextShow instance. That is,

showsPrec p (FromTextShow x) = showbToShows showbPrec p x

Since: 2

Convert a ShowS-based show function to a Builder-based one.

Since: 2.1

Convert a Builder-based show function to a ShowS-based one.

Since: 2.1