Data.Text.Format.Heavy.Build

Documentation

format :: VarContainer vars => Format -> vars -> Text

The main formatting function. This function throws error if some error detected during format string parsing or formatting itself.

formatEither :: VarContainer vars => Format -> vars -> Either String Text

The main formatting function. This version returns Left value with error description in case of error in format string or error during formatting.

makeBuilder :: VarContainer c => Format -> c -> Either String Builder

Formatters building utilities

align :: GenericFormat -> Builder -> Builder

Align text within available width according to format

applySign :: (Num a, Ord a) => Sign -> a -> Builder -> Builder

Add +/- sign to the number representation, if required

applySharp :: Bool -> Radix -> Builder -> Builder

Add 0x to the number representation, if required

convertText :: Maybe Conversion -> Builder -> Builder

Apply text conversion.

formatInt :: Integral a => GenericFormat -> a -> Builder

Format integer number according to GenericFormat

formatStr :: GenericFormat -> Text -> Builder

Format Text according to GenericFormat.

formatFloat :: RealFloat a => GenericFormat -> a -> Builder

Format floating-point number according to GenericFormat

formatBool :: BoolFormat -> Bool -> Builder

Format boolean value.