Data.Text.Format.Heavy.Instances

This module contains Formatable and VarContainer instances for most used types.

Utility data types

data Single a

Container for single parameter. Example usage:

format "Hello, {}!" (Single name)

Constructors

Single

Fields

• getSingle :: a

Instances

Eq a => Eq (Single a)

Methods

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

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

Show a => Show (Single a)

Methods

showsPrec :: Int -> Single a -> ShowS

show :: Single a -> String

showList :: [Single a] -> ShowS

Formatable a => VarContainer (Single a)

Methods

lookupVar :: VarName -> Single a -> Maybe Variable

Formatable a => Formatable (Single a)

Methods

formatVar :: VarFormat -> Single a -> Either String Builder

data Several a

Container for several parameters of the same type. Example usage:

format "{} + {} = {}" $ Several [2, 3, 5]

Constructors

Several

Fields

• getSeveral :: [a]

Instances

Eq a => Eq (Several a)

Methods

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

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

Show a => Show (Several a)

Methods

showsPrec :: Int -> Several a -> ShowS

show :: Several a -> String

showList :: [Several a] -> ShowS

Formatable a => VarContainer (Several a)

Methods

lookupVar :: VarName -> Several a -> Maybe Variable

data Shown a

Values packed in Shown will be formatted using their Show instance.

For example,

formatText "values: {}." (Shown (True, False)) ==> "values: (True, False)."

Constructors

Shown

Fields

• shown :: a

Instances

Eq a => Eq (Shown a)

Methods

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

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

Show a => Show (Shown a)

Methods

showsPrec :: Int -> Shown a -> ShowS

show :: Shown a -> String

showList :: [Shown a] -> ShowS

Show a => Formatable (Shown a)

Methods

formatVar :: VarFormat -> Shown a -> Either String Builder

Generic formatters

genericIntFormat :: Integral a => VarFormat -> a -> Either String Builder

Generic formatter for integer types

genericFloatFormat :: RealFloat a => VarFormat -> a -> Either String Builder

Generic formatter for floating-point types

Orphan instances

IsString Format

Methods

fromString :: String -> Format

VarContainer ()

Methods

lookupVar :: VarName -> () -> Maybe Variable

Formatable Bool

Methods

formatVar :: VarFormat -> Bool -> Either String Builder

Formatable Double

Methods

formatVar :: VarFormat -> Double -> Either String Builder

Formatable Float

Methods

formatVar :: VarFormat -> Float -> Either String Builder

Formatable Int

Methods

formatVar :: VarFormat -> Int -> Either String Builder

Formatable Int8

Methods

formatVar :: VarFormat -> Int8 -> Either String Builder

Formatable Int16

Methods

formatVar :: VarFormat -> Int16 -> Either String Builder

Formatable Int32

Methods

formatVar :: VarFormat -> Int32 -> Either String Builder

Formatable Int64

Methods

formatVar :: VarFormat -> Int64 -> Either String Builder

Formatable Integer

Methods

formatVar :: VarFormat -> Integer -> Either String Builder

Formatable Word8

Methods

formatVar :: VarFormat -> Word8 -> Either String Builder

Formatable Word16

Methods

formatVar :: VarFormat -> Word16 -> Either String Builder

Formatable Word32

Methods

formatVar :: VarFormat -> Word32 -> Either String Builder

Formatable Word64

Methods

formatVar :: VarFormat -> Word64 -> Either String Builder

Formatable ()

Unit type is formatted as empty string

Methods

formatVar :: VarFormat -> () -> Either String Builder

Formatable String

Methods

formatVar :: VarFormat -> String -> Either String Builder

Formatable ByteString

Methods

formatVar :: VarFormat -> ByteString -> Either String Builder

Formatable ByteString

Methods

formatVar :: VarFormat -> ByteString -> Either String Builder

Formatable Text

Methods

formatVar :: VarFormat -> Text -> Either String Builder

Formatable Text

Methods

formatVar :: VarFormat -> Text -> Either String Builder

IsVarFormat BoolFormat

Methods

parseVarFormat :: Text -> Either String BoolFormat

IsVarFormat GenericFormat

Methods

parseVarFormat :: Text -> Either String GenericFormat

Formatable x => VarContainer [(Text, x)]

Methods

lookupVar :: VarName -> [(Text, x)] -> Maybe Variable

Formatable a => VarContainer (Maybe a)

Maybe container contains one variable (named 0); Nothing contains an empty string.

Methods

lookupVar :: VarName -> Maybe a -> Maybe Variable

Formatable a => Formatable (Maybe a)

Methods

formatVar :: VarFormat -> Maybe a -> Either String Builder

(Formatable a, Formatable b) => VarContainer (a, b)

Methods

lookupVar :: VarName -> (a, b) -> Maybe Variable

Formatable x => VarContainer (Map Text x)

Methods

lookupVar :: VarName -> Map Text x -> Maybe Variable

(Formatable a, Formatable b) => Formatable (Either a b)

Methods

formatVar :: VarFormat -> Either a b -> Either String Builder

(Formatable a, Formatable b, Formatable c) => VarContainer (a, b, c)

Methods

lookupVar :: VarName -> (a, b, c) -> Maybe Variable

(Formatable a, Formatable b, Formatable c, Formatable d) => VarContainer (a, b, c, d)

Methods

lookupVar :: VarName -> (a, b, c, d) -> Maybe Variable

(Formatable a, Formatable b, Formatable c, Formatable d, Formatable e) => VarContainer (a, b, c, d, e)

Methods

lookupVar :: VarName -> (a, b, c, d, e) -> Maybe Variable

(Formatable a, Formatable b, Formatable c, Formatable d, Formatable e, Formatable f) => VarContainer (a, b, c, d, e, f)

Methods

lookupVar :: VarName -> (a, b, c, d, e, f) -> Maybe Variable

(Formatable a, Formatable b, Formatable c, Formatable d, Formatable e, Formatable f, Formatable g) => VarContainer (a, b, c, d, e, f, g)

Methods

lookupVar :: VarName -> (a, b, c, d, e, f, g) -> Maybe Variable