Formatting.Formatters

Formatting functions.

Text/string types

text :: Format Text

Output a lazy text.

stext :: Format Text

Output a strict text.

string :: Format String

Output a string.

builder :: Format Builder

Build a builder.

fconst :: Builder -> Format a

Like const but for formatters.

Numbers

int :: Integral a => Format a

Render an integral e.g. 123 -> "123", 0 -> "0".

float :: Real a => Format a

Render some floating point with the usual notation, e.g. 123.32 => "123.32"

expt :: Real a => Int -> Format a

Render a floating point number using scientific/engineering notation (e.g. 2.3e123), with the given number of decimal places.

fixed :: Real a => Int -> Format a

Render a floating point number using normal notation, with the given number of decimal places.

prec :: Real a => Int -> Format a

Render a floating point number, with the given number of digits of precision. Uses decimal notation for values between 0.1 and 9,999,999, and scientific notation otherwise.

shortest :: Real a => Format a

Render a floating point number using the smallest number of digits that correctly represent it.

commas :: (Buildable n, Integral n) => Format n

Add commas to an integral, e.g 12000 -> 12,000.

ords :: Integral n => Format n

Add a suffix to an integral, e.g. 1st, 2nd, 3rd, 21st.

Padding

left :: Buildable a => Int -> Char -> Format a

Pad the left hand side of a string until it reaches k characters wide, if necessary filling with character c.

right :: Buildable a => Int -> Char -> Format a

Pad the right hand side of a string until it reaches k characters wide, if necessary filling with character c.

Bases

hex :: Integral a => Format a

Render an integer using hexadecimal notation. (No leading 0x is added.)

Buildables

build :: Buildable a => Format a

Build anything that implements the Buildable class.

class Buildable p

The class of types that can be rendered to a Builder.

Instances

Buildable Bool

Buildable Char

Buildable Double

Buildable Float

Buildable Int

Buildable Int8

Buildable Int16

Buildable Int32

Buildable Int64

Buildable Integer

Buildable Word

Buildable Word8

Buildable Word16

Buildable Word32

Buildable Word64

Buildable WordPtr

Buildable IntPtr

Buildable Builder

Buildable Text

Buildable Text

Buildable LocalTime

Buildable ZonedTime

Buildable TimeOfDay

Buildable TimeZone

Buildable UTCTime

Buildable NominalDiffTime

Buildable Day

Buildable UniversalTime

Buildable DiffTime

Buildable [Char]

(Integral a, Buildable a) => Buildable (Ratio a)

Buildable (Ptr a)

Buildable a => Buildable (Maybe a)

Integral a => Buildable (Hex a)

Show a => Buildable (Shown a)