Data.Text.Format.Types

Types for text mangling.

Documentation

data Format

A format string. This is intentionally incompatible with other string types, to make it difficult to construct a format string by concatenating string fragments (a very common way to accidentally make code vulnerable to malicious data).

This type is an instance of IsString, so the easiest way to construct a query is to enable the OverloadedStrings language extension and then simply write the query in double quotes.

{-# LANGUAGE OverloadedStrings #-}

import Data.Text.Format

f :: Format
f = "hello {}"

The underlying type is Text, so literal Haskell strings that contain Unicode characters will be correctly handled.

Instances

Eq Format

Defined in Data.Text.Format.Types.Internal

Methods

(==) :: Format -> Format -> Bool

(/=) :: Format -> Format -> Bool

Ord Format

Defined in Data.Text.Format.Types.Internal

Methods

compare :: Format -> Format -> Ordering

(<) :: Format -> Format -> Bool

(<=) :: Format -> Format -> Bool

(>) :: Format -> Format -> Bool

(>=) :: Format -> Format -> Bool

max :: Format -> Format -> Format

min :: Format -> Format -> Format

Show Format

Defined in Data.Text.Format.Types.Internal

Methods

showsPrec :: Int -> Format -> ShowS

show :: Format -> String

showList :: [Format] -> ShowS

IsString Format

Defined in Data.Text.Format.Types.Internal

Methods

fromString :: String -> Format

Semigroup Format

Defined in Data.Text.Format.Types.Internal

Methods

(<>) :: Format -> Format -> Format

sconcat :: NonEmpty Format -> Format

stimes :: Integral b => b -> Format -> Format

Monoid Format

Defined in Data.Text.Format.Types.Internal

Methods

mempty :: Format

mappend :: Format -> Format -> Format

mconcat :: [Format] -> Format

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)

Defined in Data.Text.Format.Types.Internal

Methods

minBound :: Only a

maxBound :: Only a

Enum a => Enum (Only a)

Defined in Data.Text.Format.Types.Internal

Methods

succ :: Only a -> Only a

pred :: Only a -> Only a

toEnum :: Int -> Only a

fromEnum :: Only a -> Int

enumFrom :: Only a -> [Only a]

enumFromThen :: Only a -> Only a -> [Only a]

enumFromTo :: Only a -> Only a -> [Only a]

enumFromThenTo :: Only a -> Only a -> Only a -> [Only a]

Eq a => Eq (Only a)

Defined in Data.Text.Format.Types.Internal

Methods

(==) :: Only a -> Only a -> Bool

(/=) :: Only a -> Only a -> Bool

Floating a => Floating (Only a)

Defined in Data.Text.Format.Types.Internal

Methods

pi :: Only a

exp :: Only a -> Only a

log :: Only a -> Only a

sqrt :: Only a -> Only a

(**) :: Only a -> Only a -> Only a

logBase :: Only a -> Only a -> Only a

sin :: Only a -> Only a

cos :: Only a -> Only a

tan :: Only a -> Only a

asin :: Only a -> Only a

acos :: Only a -> Only a

atan :: Only a -> Only a

sinh :: Only a -> Only a

cosh :: Only a -> Only a

tanh :: Only a -> Only a

asinh :: Only a -> Only a

acosh :: Only a -> Only a

atanh :: Only a -> Only a

log1p :: Only a -> Only a

expm1 :: Only a -> Only a

log1pexp :: Only a -> Only a

log1mexp :: Only a -> Only a

Fractional a => Fractional (Only a)

Defined in Data.Text.Format.Types.Internal

Methods

(/) :: Only a -> Only a -> Only a

recip :: Only a -> Only a

fromRational :: Rational -> Only a

Integral a => Integral (Only a)

Defined in Data.Text.Format.Types.Internal

Methods

quot :: Only a -> Only a -> Only a

rem :: Only a -> Only a -> Only a

div :: Only a -> Only a -> Only a

mod :: Only a -> Only a -> Only a

quotRem :: Only a -> Only a -> (Only a, Only a)

divMod :: Only a -> Only a -> (Only a, Only a)

toInteger :: Only a -> Integer

Num a => Num (Only a)

Defined in Data.Text.Format.Types.Internal

Methods

(+) :: Only a -> Only a -> Only a

(-) :: Only a -> Only a -> Only a

(*) :: Only a -> Only a -> Only a

negate :: Only a -> Only a

abs :: Only a -> Only a

signum :: Only a -> Only a

fromInteger :: Integer -> Only a

Ord a => Ord (Only a)

Defined in Data.Text.Format.Types.Internal

Methods

compare :: Only a -> Only a -> Ordering

(<) :: Only a -> Only a -> Bool

(<=) :: Only a -> Only a -> Bool

(>) :: Only a -> Only a -> Bool

(>=) :: Only a -> Only a -> Bool

max :: Only a -> Only a -> Only a

min :: Only a -> Only a -> Only a

Read a => Read (Only a)

Defined in Data.Text.Format.Types.Internal

Methods

readsPrec :: Int -> ReadS (Only a)

readList :: ReadS [Only a]

readPrec :: ReadPrec (Only a)

readListPrec :: ReadPrec [Only a]

Real a => Real (Only a)

Defined in Data.Text.Format.Types.Internal

Methods

toRational :: Only a -> Rational

RealFloat a => RealFloat (Only a)

Defined in Data.Text.Format.Types.Internal

Methods

floatRadix :: Only a -> Integer

floatDigits :: Only a -> Int

floatRange :: Only a -> (Int, Int)

decodeFloat :: Only a -> (Integer, Int)

encodeFloat :: Integer -> Int -> Only a

exponent :: Only a -> Int

significand :: Only a -> Only a

scaleFloat :: Int -> Only a -> Only a

isNaN :: Only a -> Bool

isInfinite :: Only a -> Bool

isDenormalized :: Only a -> Bool

isNegativeZero :: Only a -> Bool

isIEEE :: Only a -> Bool

atan2 :: Only a -> Only a -> Only a

RealFrac a => RealFrac (Only a)

Defined in Data.Text.Format.Types.Internal

Methods

properFraction :: Integral b => Only a -> (b, Only a)

truncate :: Integral b => Only a -> b

round :: Integral b => Only a -> b

ceiling :: Integral b => Only a -> b

floor :: Integral b => Only a -> b

Show a => Show (Only a)

Defined in Data.Text.Format.Types.Internal

Methods

showsPrec :: Int -> Only a -> ShowS

show :: Only a -> String

showList :: [Only a] -> ShowS

Buildable a => Params (Only a)

Defined in Data.Text.Format.Params

Methods

buildParams :: Only a -> [Builder]

newtype Shown a

Render a value using its Show instance.

Constructors

Shown

Fields

• shown :: a

Instances

Bounded a => Bounded (Shown a)

Defined in Data.Text.Format.Types.Internal

Methods

minBound :: Shown a

maxBound :: Shown a

Enum a => Enum (Shown a)

Defined in Data.Text.Format.Types.Internal

Methods

succ :: Shown a -> Shown a

pred :: Shown a -> Shown a

toEnum :: Int -> Shown a

fromEnum :: Shown a -> Int

enumFrom :: Shown a -> [Shown a]

enumFromThen :: Shown a -> Shown a -> [Shown a]

enumFromTo :: Shown a -> Shown a -> [Shown a]

enumFromThenTo :: Shown a -> Shown a -> Shown a -> [Shown a]

Eq a => Eq (Shown a)

Defined in Data.Text.Format.Types.Internal

Methods

(==) :: Shown a -> Shown a -> Bool

(/=) :: Shown a -> Shown a -> Bool

Floating a => Floating (Shown a)

Defined in Data.Text.Format.Types.Internal

Methods

pi :: Shown a

exp :: Shown a -> Shown a

log :: Shown a -> Shown a

sqrt :: Shown a -> Shown a

(**) :: Shown a -> Shown a -> Shown a

logBase :: Shown a -> Shown a -> Shown a

sin :: Shown a -> Shown a

cos :: Shown a -> Shown a

tan :: Shown a -> Shown a

asin :: Shown a -> Shown a

acos :: Shown a -> Shown a

atan :: Shown a -> Shown a

sinh :: Shown a -> Shown a

cosh :: Shown a -> Shown a

tanh :: Shown a -> Shown a

asinh :: Shown a -> Shown a

acosh :: Shown a -> Shown a

atanh :: Shown a -> Shown a

log1p :: Shown a -> Shown a

expm1 :: Shown a -> Shown a

log1pexp :: Shown a -> Shown a

log1mexp :: Shown a -> Shown a

Fractional a => Fractional (Shown a)

Defined in Data.Text.Format.Types.Internal

Methods

(/) :: Shown a -> Shown a -> Shown a

recip :: Shown a -> Shown a

fromRational :: Rational -> Shown a

Integral a => Integral (Shown a)

Defined in Data.Text.Format.Types.Internal

Methods

quot :: Shown a -> Shown a -> Shown a

rem :: Shown a -> Shown a -> Shown a

div :: Shown a -> Shown a -> Shown a

mod :: Shown a -> Shown a -> Shown a

quotRem :: Shown a -> Shown a -> (Shown a, Shown a)

divMod :: Shown a -> Shown a -> (Shown a, Shown a)

toInteger :: Shown a -> Integer

Num a => Num (Shown a)

Defined in Data.Text.Format.Types.Internal

Methods

(+) :: Shown a -> Shown a -> Shown a

(-) :: Shown a -> Shown a -> Shown a

(*) :: Shown a -> Shown a -> Shown a

negate :: Shown a -> Shown a

abs :: Shown a -> Shown a

signum :: Shown a -> Shown a

fromInteger :: Integer -> Shown a

Ord a => Ord (Shown a)

Defined in Data.Text.Format.Types.Internal

Methods

compare :: Shown a -> Shown a -> Ordering

(<) :: Shown a -> Shown a -> Bool

(<=) :: Shown a -> Shown a -> Bool

(>) :: Shown a -> Shown a -> Bool

(>=) :: Shown a -> Shown a -> Bool

max :: Shown a -> Shown a -> Shown a

min :: Shown a -> Shown a -> Shown a

Read a => Read (Shown a)

Defined in Data.Text.Format.Types.Internal

Methods

readsPrec :: Int -> ReadS (Shown a)

readList :: ReadS [Shown a]

readPrec :: ReadPrec (Shown a)

readListPrec :: ReadPrec [Shown a]

Real a => Real (Shown a)

Defined in Data.Text.Format.Types.Internal

Methods

toRational :: Shown a -> Rational

RealFloat a => RealFloat (Shown a)

Defined in Data.Text.Format.Types.Internal

Methods

floatRadix :: Shown a -> Integer

floatDigits :: Shown a -> Int

floatRange :: Shown a -> (Int, Int)

decodeFloat :: Shown a -> (Integer, Int)

encodeFloat :: Integer -> Int -> Shown a

exponent :: Shown a -> Int

significand :: Shown a -> Shown a

scaleFloat :: Int -> Shown a -> Shown a

isNaN :: Shown a -> Bool

isInfinite :: Shown a -> Bool

isDenormalized :: Shown a -> Bool

isNegativeZero :: Shown a -> Bool

isIEEE :: Shown a -> Bool

atan2 :: Shown a -> Shown a -> Shown a

RealFrac a => RealFrac (Shown a)

Defined in Data.Text.Format.Types.Internal

Methods

properFraction :: Integral b => Shown a -> (b, Shown a)

truncate :: Integral b => Shown a -> b

round :: Integral b => Shown a -> b

ceiling :: Integral b => Shown a -> b

floor :: Integral b => Shown a -> b

Show a => Show (Shown a)

Defined in Data.Text.Format.Types.Internal

Methods

showsPrec :: Int -> Shown a -> ShowS

show :: Shown a -> String

showList :: [Shown a] -> ShowS

Show a => Buildable (Shown a)

Defined in Data.Text.Buildable

Methods

build :: Shown a -> Builder

Integer format control

newtype Hex a

Render an integral type in hexadecimal.

Constructors

Hex a

Instances

Enum a => Enum (Hex a)

Defined in Data.Text.Format.Types.Internal

Methods

succ :: Hex a -> Hex a

pred :: Hex a -> Hex a

toEnum :: Int -> Hex a

fromEnum :: Hex a -> Int

enumFrom :: Hex a -> [Hex a]

enumFromThen :: Hex a -> Hex a -> [Hex a]

enumFromTo :: Hex a -> Hex a -> [Hex a]

enumFromThenTo :: Hex a -> Hex a -> Hex a -> [Hex a]

Eq a => Eq (Hex a)

Defined in Data.Text.Format.Types.Internal

Methods

(==) :: Hex a -> Hex a -> Bool

(/=) :: Hex a -> Hex a -> Bool

Integral a => Integral (Hex a)

Defined in Data.Text.Format.Types.Internal

Methods

quot :: Hex a -> Hex a -> Hex a

rem :: Hex a -> Hex a -> Hex a

div :: Hex a -> Hex a -> Hex a

mod :: Hex a -> Hex a -> Hex a

quotRem :: Hex a -> Hex a -> (Hex a, Hex a)

divMod :: Hex a -> Hex a -> (Hex a, Hex a)

toInteger :: Hex a -> Integer

Num a => Num (Hex a)

Defined in Data.Text.Format.Types.Internal

Methods

(+) :: Hex a -> Hex a -> Hex a

(-) :: Hex a -> Hex a -> Hex a

(*) :: Hex a -> Hex a -> Hex a

negate :: Hex a -> Hex a

abs :: Hex a -> Hex a

signum :: Hex a -> Hex a

fromInteger :: Integer -> Hex a

Ord a => Ord (Hex a)

Defined in Data.Text.Format.Types.Internal

Methods

compare :: Hex a -> Hex a -> Ordering

(<) :: Hex a -> Hex a -> Bool

(<=) :: Hex a -> Hex a -> Bool

(>) :: Hex a -> Hex a -> Bool

(>=) :: Hex a -> Hex a -> Bool

max :: Hex a -> Hex a -> Hex a

min :: Hex a -> Hex a -> Hex a

Read a => Read (Hex a)

Defined in Data.Text.Format.Types.Internal

Methods

readsPrec :: Int -> ReadS (Hex a)

readList :: ReadS [Hex a]

readPrec :: ReadPrec (Hex a)

readListPrec :: ReadPrec [Hex a]

Real a => Real (Hex a)

Defined in Data.Text.Format.Types.Internal

Methods

toRational :: Hex a -> Rational

Show a => Show (Hex a)

Defined in Data.Text.Format.Types.Internal

Methods

showsPrec :: Int -> Hex a -> ShowS

show :: Hex a -> String

showList :: [Hex a] -> ShowS

Integral a => Buildable (Hex a)

Defined in Data.Text.Buildable

Methods

build :: Hex a -> Builder