Copyright	(C) 2014-2015 Ryan Scott
License	BSD-style (see the file LICENSE)
Maintainer	Ryan Scott
Stability	Provisional
Portability	GHC
Safe Haskell	None
Language	Haskell2010

Text.Show.Text

Contents

The Show-related classes
Builders
Printing values
Conversion between String and Text Show

Description

Efficiently convert from values to Text via Builders.

Since: 0.1

Synopsis

The `Show`-related classes

`Show`

class Show a where Source

Conversion of values to Text. Because there are both strict and lazy Text variants, the Show 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 Show instances. As an example:

import Text.Show.Text

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

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

Since: 0.1

Minimal complete definition

showbPrec | showb

Methods

showbPrec Source

Arguments

:: Int	The operator precedence of the enclosing context (a number from `0` to `11`). Function application has precedence `10`.
-> a	The value to be converted to a `String`.
-> Builder

Convert a value to a Builder with the given predence.

Since: 0.1

showb :: a -> Builder Source

A specialized variant of showbPrec using precedence context zero.

Since: 0.1

showbList :: [a] -> Builder Source

Allows for specialized display of lists. This is used, for example, when showing lists of Chars.

Since: 0.1

Instances

Show Bool
Show Char
Show Double
Show Float
Show Int
Show Int8
Show Int16
Show Int32
Show Int64
Show Integer
Show Ordering
Show Word
Show Word8
Show Word16
Show Word32
Show Word64
Show ()
Show Handle
Show GCStats
Show DataType
Show Constr
Show DataRep
Show ConstrRep
Show Fixity
Show Version
Show SomeNat
Show SomeSymbol
Show TypeRep
Show TyCon
Show HandlePosn
Show FdKey
Show Event
Show IOMode
Show PatternMatchFail
Show RecSelError
Show RecConError
Show RecUpdError
Show NoMethodError
Show NonTermination
Show NestedAtomically
Show ThreadId
Show BlockReason
Show ThreadStatus
Show CodingFailureMode
Show CDev
Show CIno
Show CMode
Show COff
Show CPid
Show CSsize
Show CGid
Show CNlink
Show CUid
Show CCc
Show CSpeed
Show CTcflag
Show CRLim
Show Fd
Show BlockedIndefinitelyOnMVar
Show BlockedIndefinitelyOnSTM
Show Deadlock
Show AssertionFailed
Show SomeAsyncException
Show AsyncException
Show ArrayException
Show ExitCode
Show BufferMode
Show Newline
Show NewlineMode
Show SeekMode
Show TextEncoding
Show CodingProgress
Show WordPtr
Show IntPtr
Show GeneralCategory
Show CChar
Show CSChar
Show CUChar
Show CShort
Show CUShort
Show CInt
Show CUInt
Show CLong
Show CULong
Show CLLong
Show CULLong
Show CFloat
Show CDouble
Show CPtrdiff
Show CSize
Show CWchar
Show CSigAtomic
Show CClock
Show CTime
Show CUSeconds
Show CSUSeconds
Show CIntPtr
Show CUIntPtr
Show CIntMax
Show CUIntMax
Show Dynamic
Show MaskingState
Show IOException
Show ErrorCall
Show ArithException
Show All
Show Any
Show Arity
Show Fixity
Show Associativity
Show TypeRep
Show TyCon
Show Fingerprint
Show Lexeme
Show Number
Show SomeException
Show ByteString
Show ByteString
Show ShortByteString
Show Natural
Show FPFormat
Show Builder
Show Text
Show I16
Show Decoding
Show Size
Show Text
Show UnicodeException
Show Void
Show ConType
Show a => Show [a]
Show a => Show (Ratio a)
Show (Ptr a)
Show (FunPtr a)
Show (U1 p)
Show p0 => Show (Par1 p)
Show (ForeignPtr a)
HasResolution a => Show (Fixed a)
Show a => Show (Complex a)
Show a0 => Show (ZipList a)
Show a0 => Show (Dual a)
Show a0 => Show (Sum a)
Show a0 => Show (Product a)
Show a0 => Show (First a)
Show a0 => Show (Last a)
Show a0 => Show (Down a)
Show a0 => Show (Maybe a)
Show a => Show (Identity a)
Show a => Show (FromTextShow a)
Show a => Show (FromStringShow a)
Show (a -> b)
(Show a0, Show b0) => Show (Either a b)
Show (f p) => Show (Rec1 f p)
(Show a0, Show b0) => Show (a, b)
Show (ST s a)
(IArray UArray e, Ix i, Show i, Show e) => Show (UArray i e)
(Show i, Show e, Ix i) => Show (Array i e)
Show a => Show (Const a b)
Show (Proxy * s)
Typeable (* -> Constraint) Show
Show c => Show (K1 i c p)
(Show (f p), Show (g p)) => Show ((:+:) f g p)
(Show (f p), Show (g p)) => Show ((:*:) f g p)
Show (f (g p)) => Show ((:.:) f g p)
(Show a0, Show b0, Show c0) => Show (a, b, c)
Show (Coercion * a b)
Show ((:~:) * a b)
Show (f p) => Show (M1 i c f p)
(Show a0, Show b0, Show c0, Show d0) => Show (a, b, c, d)
(Show a0, Show b0, Show c0, Show d0, Show e0) => Show (a, b, c, d, e)
(Show a0, Show b0, Show c0, Show d0, Show e0, Show f0) => Show (a, b, c, d, e, f)
(Show a0, Show b0, Show c0, Show d0, Show e0, Show f0, Show g0) => Show (a, b, c, d, e, f, g)
(Show a0, Show b0, Show c0, Show d0, Show e0, Show f0, Show g0, Show h0) => Show (a, b, c, d, e, f, g, h)
(Show a0, Show b0, Show c0, Show d0, Show e0, Show f0, Show g0, Show h0, Show i0) => Show (a, b, c, d, e, f, g, h, i)
(Show a0, Show b0, Show c0, Show d0, Show e0, Show f0, Show g0, Show h0, Show i0, Show j0) => Show (a, b, c, d, e, f, g, h, i, j)
(Show a0, Show b0, Show c0, Show d0, Show e0, Show f0, Show g0, Show h0, Show i0, Show j0, Show k0) => Show (a, b, c, d, e, f, g, h, i, j, k)
(Show a0, Show b0, Show c0, Show d0, Show e0, Show f0, Show g0, Show h0, Show i0, Show j0, Show k0, Show l0) => Show (a, b, c, d, e, f, g, h, i, j, k, l)
(Show a0, Show b0, Show c0, Show d0, Show e0, Show f0, Show g0, Show h0, Show i0, Show j0, Show k0, Show l0, Show m0) => Show (a, b, c, d, e, f, g, h, i, j, k, l, m)
(Show a0, Show b0, Show c0, Show d0, Show e0, Show f0, Show g0, Show h0, Show i0, Show j0, Show k0, Show l0, Show m0, Show n0) => Show (a, b, c, d, e, f, g, h, i, j, k, l, m, n)
(Show a0, Show b0, Show c0, Show d0, Show e0, Show f0, Show g0, Show h0, Show i0, Show j0, Show k0, Show l0, Show m0, Show n0, Show o0) => Show (a, b, c, d, e, f, g, h, i, j, k, l, m, n, o)

show :: Show a => a -> Text Source

Constructs a strict Text from a single value.

Since: 0.1

showLazy :: Show a => a -> Text Source

Constructs a lazy Text from a single value.

Since: 0.3

showPrec :: Show a => Int -> a -> Text Source

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

Since: 0.3

showPrecLazy :: Show a => Int -> a -> Text Source

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

Since: 0.3

showList :: Show a => [a] -> Text Source

Construct a strict Text from a list of values.

Since: 0.3.1

showListLazy :: Show a => [a] -> Text Source

Construct a lazy Text from a list of values.

Since: 0.3.1

showbParen :: Bool -> Builder -> Builder Source

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

Since: 0.1

showbSpace :: Builder Source

Construct a Builder containing a single space character.

Since: 0.5

`Show1`

class Show1 f where Source

Lifting of the Show class to unary type constructors.

Since: 1

Methods

showbPrecWith :: (Int -> a -> Builder) -> Int -> f a -> Builder Source

Lifts a showbPrec function through the type constructor.

Since: 1

Instances

Show1 []
Show1 Ratio
Show1 Ptr
Show1 FunPtr
Show1 U1
Show1 Par1
Show1 ForeignPtr
Show1 Complex
Show1 ZipList
Show1 Dual
Show1 Sum
Show1 Product
Show1 First
Show1 Last
Show1 Down
Show1 Maybe
Show1 Identity
Show1 FromTextShow
Show1 ((->) a)
Show a0 => Show1 (Either a)
Show1 f0 => Show1 (Rec1 f)
Show a0 => Show1 ((,) a)
Show1 (ST s)
Show a => Show1 (Const a)
Show1 (Proxy *)
Show c => Show1 (K1 i c)
(Show1 f0, Show1 g0) => Show1 ((:+:) f g)
(Show1 f0, Show1 g0) => Show1 ((:*:) f g)
(Show1 f0, Show1 g0) => Show1 ((:.:) f g)
(Show a0, Show b0) => Show1 ((,,) a b)
Show1 (Coercion * a)
Show1 ((:~:) * a)
Typeable ((* -> *) -> Constraint) Show1
Show1 f => Show1 (M1 i c f)
(Show a0, Show b0, Show c0) => Show1 ((,,,) a b c)
(Show a0, Show b0, Show c0, Show d0) => Show1 ((,,,,) a b c d)
(Show a0, Show b0, Show c0, Show d0, Show e0) => Show1 ((,,,,,) a b c d e)
(Show a0, Show b0, Show c0, Show d0, Show e0, Show f0) => Show1 ((,,,,,,) a b c d e f)
(Show a0, Show b0, Show c0, Show d0, Show e0, Show f0, Show g0) => Show1 ((,,,,,,,) a b c d e f g)
(Show a0, Show b0, Show c0, Show d0, Show e0, Show f0, Show g0, Show h0) => Show1 ((,,,,,,,,) a b c d e f g h)
(Show a0, Show b0, Show c0, Show d0, Show e0, Show f0, Show g0, Show h0, Show i0) => Show1 ((,,,,,,,,,) a b c d e f g h i)
(Show a0, Show b0, Show c0, Show d0, Show e0, Show f0, Show g0, Show h0, Show i0, Show j0) => Show1 ((,,,,,,,,,,) a b c d e f g h i j)
(Show a0, Show b0, Show c0, Show d0, Show e0, Show f0, Show g0, Show h0, Show i0, Show j0, Show k0) => Show1 ((,,,,,,,,,,,) a b c d e f g h i j k)
(Show a0, Show b0, Show c0, Show d0, Show e0, Show f0, Show g0, Show h0, Show i0, Show j0, Show k0, Show l0) => Show1 ((,,,,,,,,,,,,) a b c d e f g h i j k l)
(Show a0, Show b0, Show c0, Show d0, Show e0, Show f0, Show g0, Show h0, Show i0, Show j0, Show k0, Show l0, Show m0) => Show1 ((,,,,,,,,,,,,,) a b c d e f g h i j k l m)
(Show a0, Show b0, Show c0, Show d0, Show e0, Show f0, Show g0, Show h0, Show i0, Show j0, Show k0, Show l0, Show m0, Show n0) => Show1 ((,,,,,,,,,,,,,,) a b c d e f g h i j k l m n)

showbPrec1 :: (Show1 f, Show a) => Int -> f a -> Builder Source

Lift the standard showbPrec function through the type constructor.

Since: 1

showbUnaryWith :: (Int -> a -> Builder) -> Builder -> Int -> a -> Builder Source

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: 1

`Show2`

class Show2 f where Source

Lifting of the Show class to binary type constructors.

Since: 1

Methods

showbPrecWith2 :: (Int -> a -> Builder) -> (Int -> b -> Builder) -> Int -> f a b -> Builder Source

Lifts showbPrec functions through the type constructor.

Since: 1

Instances

Show2 (->)
Show2 Either
Show2 (,)
Show2 ST
Show2 Const
Show2 (K1 i)
Show a0 => Show2 ((,,) a)
Show2 (Coercion *)
Show2 ((:~:) *)
(Show a0, Show b0) => Show2 ((,,,) a b)
Typeable ((* -> * -> *) -> Constraint) Show2
(Show a0, Show b0, Show c0) => Show2 ((,,,,) a b c)
(Show a0, Show b0, Show c0, Show d0) => Show2 ((,,,,,) a b c d)
(Show a0, Show b0, Show c0, Show d0, Show e0) => Show2 ((,,,,,,) a b c d e)
(Show a0, Show b0, Show c0, Show d0, Show e0, Show f0) => Show2 ((,,,,,,,) a b c d e f)
(Show a0, Show b0, Show c0, Show d0, Show e0, Show f0, Show g0) => Show2 ((,,,,,,,,) a b c d e f g)
(Show a0, Show b0, Show c0, Show d0, Show e0, Show f0, Show g0, Show h0) => Show2 ((,,,,,,,,,) a b c d e f g h)
(Show a0, Show b0, Show c0, Show d0, Show e0, Show f0, Show g0, Show h0, Show i0) => Show2 ((,,,,,,,,,,) a b c d e f g h i)
(Show a0, Show b0, Show c0, Show d0, Show e0, Show f0, Show g0, Show h0, Show i0, Show j0) => Show2 ((,,,,,,,,,,,) a b c d e f g h i j)
(Show a0, Show b0, Show c0, Show d0, Show e0, Show f0, Show g0, Show h0, Show i0, Show j0, Show k0) => Show2 ((,,,,,,,,,,,,) a b c d e f g h i j k)
(Show a0, Show b0, Show c0, Show d0, Show e0, Show f0, Show g0, Show h0, Show i0, Show j0, Show k0, Show l0) => Show2 ((,,,,,,,,,,,,,) a b c d e f g h i j k l)
(Show a0, Show b0, Show c0, Show d0, Show e0, Show f0, Show g0, Show h0, Show i0, Show j0, Show k0, Show l0, Show m0) => Show2 ((,,,,,,,,,,,,,,) a b c d e f g h i j k l m)

showbPrec2 :: (Show2 f, Show a, Show b) => Int -> f a b -> Builder Source

Lift two showbPrec functions through the type constructor.

Since: 1

showbBinaryWith :: (Int -> a -> Builder) -> (Int -> b -> Builder) -> Builder -> Int -> a -> b -> Builder Source

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: 1

`Builder`s

module Data.Text.Lazy.Builder

toString :: Builder -> String Source

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

Since: 0.4.1

toText :: Builder -> Text Source

Convert a Builder to a strict Text.

Since: 0.4.1

lengthB :: Builder -> Int64 Source

Computes the length of a Builder.

Since: 0.3

unlinesB :: [Builder] -> Builder Source

Merges several Builders, separating them by newlines.

Since: 0.1

unwordsB :: [Builder] -> Builder Source

Merges several Builders, separating them by spaces.

Since: 0.1

Printing values

print :: Show a => a -> IO () Source

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

Since: 0.1

printLazy :: Show a => a -> IO () Source

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

Since: 0.3

hPrint :: Show a => Handle -> a -> IO () Source

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

Since: 0.3

hPrintLazy :: Show a => Handle -> a -> IO () Source

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

Since: 0.3

Conversion between `String` and `Text` `Show`

newtype FromStringShow a Source

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

showbPrec p (FromStringShow x) = fromString (showsPrec p x "")

Since: 0.5

Constructors

FromStringShow
Fields fromStringShow :: a

Instances

Functor FromStringShow
Foldable FromStringShow
Traversable FromStringShow
Generic1 FromStringShow
Eq a => Eq (FromStringShow a)
Data a => Data (FromStringShow a)
Ord a => Ord (FromStringShow a)
Read a => Read (FromStringShow a)
Show a => Show (FromStringShow a)
Generic (FromStringShow a)
Show a => Show (FromStringShow a)
Typeable (* -> *) FromStringShow
Typeable (k -> FromStringShow k) (FromStringShow k)
type Rep1 FromStringShow
type Rep (FromStringShow a)

newtype FromTextShow a Source

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

showsPrec p (FromTextShow x) str = toString (showbPrec p x) ++ str

Since: 0.6

Constructors

FromTextShow
Fields fromTextShow :: a

Instances

Functor FromTextShow
Foldable FromTextShow
Traversable FromTextShow
Generic1 FromTextShow
Show1 FromTextShow
Eq a => Eq (FromTextShow a)
Data a => Data (FromTextShow a)
Ord a => Ord (FromTextShow a)
Read a => Read (FromTextShow a)
Show a => Show (FromTextShow a)
Generic (FromTextShow a)
Show a => Show (FromTextShow a)
Typeable (* -> *) FromTextShow
Typeable (k -> FromTextShow k) (FromTextShow k)
type Rep1 FromTextShow
type Rep (FromTextShow a)

The Show-related classes

Show

Show1

Show2

Builders

Printing values

Conversion between String and Text Show

The `Show`-related classes

`Show`

`Show1`

`Show2`

`Builder`s

Conversion between `String` and `Text` `Show`