Data.Text.Format

Fast, efficient, flexible support for formatting text strings.

Types

newtype Only a

Use this newtype wrapper for your single parameter if you are formatting a string containing exactly one substitution site.

Constructors

Only

Fields

fromOnly :: a

Instances

Bounded a => Bounded (Only a)

Enum a => Enum (Only a)

Eq a => Eq (Only a)

Floating a => Floating (Only a)

Fractional a => Fractional (Only a)

Integral a => Integral (Only a)

Num a => Num (Only a)

Ord a => Ord (Only a)

Read a => Read (Only a)

Real a => Real (Only a)

RealFloat a => RealFloat (Only a)

RealFrac a => RealFrac (Only a)

Show a => Show (Only a)

Buildable a => Params (Only a)

Types for format control

newtype Fast a

Render a floating point number using a much faster algorithm than the default (up to 10x faster). This performance comes with a potential cost in readability, as the faster algorithm can produce strings that are longer than the default algorithm (e.g. "1.3300000000000001" instead of "1.33").

Constructors

Fast

Fields

fromFast :: a

Instances

Eq a => Eq (Fast a)

Floating a => Floating (Fast a)

Fractional a => Fractional (Fast a)

Num a => Num (Fast a)

Ord a => Ord (Fast a)

Read a => Read (Fast a)

Real a => Real (Fast a)

RealFloat a => RealFloat (Fast a)

RealFrac a => RealFrac (Fast a)

Show a => Show (Fast a)

Buildable (Fast Double)

Buildable (Fast Float)

newtype Shown a

Render a value using its Show instance.

Constructors

Shown

Fields

shown :: a

Instances

Bounded a => Bounded (Shown a)

Enum a => Enum (Shown a)

Eq a => Eq (Shown a)

Floating a => Floating (Shown a)

Fractional a => Fractional (Shown a)

Integral a => Integral (Shown a)

Num a => Num (Shown a)

Ord a => Ord (Shown a)

Read a => Read (Shown a)

Real a => Real (Shown a)

RealFloat a => RealFloat (Shown a)

RealFrac a => RealFrac (Shown a)

Show a => Show (Shown a)

Show a => Buildable (Shown a)

Functions

Rendering

format :: Params ps => Text -> ps -> Text

Render a format string and arguments to a Text.

print :: Params ps => Text -> ps -> IO ()

Render a format string and arguments, then print the result.

hprint :: Params ps => Handle -> Text -> ps -> IO ()

Render a format string and arguments, then print the result to the given file handle.

build :: Params ps => Text -> ps -> Builder

Render a format string and arguments to a Builder.

Functions for format control

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

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

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

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