Data.Text.Format.Simple

Documentation

format :: Text -> SubMap -> Either String (Text, [Name])

Compile a string to a format string and substitute the identifiers from the provided function into it.

Fails if the string canno be parsed. Retuns the rendered string and a list of names which were used in the string but could not be resolved by the function.

format' :: Text -> SubMap -> Text

Compile a string to a format string and substitute the identifiers from the provided function into it.

All errors are ignored. Parse failure is thrown as an error and the missing names are discarded.

formatC :: Compiled -> SubMap -> (Text, [Name])

Like format but with the string already compiled

formatC' :: Compiled -> SubMap -> Text

Like format' but with the string already compiled

type SubMap = Name -> Maybe Text

Resolver for names.

data Compiled

A precompiled format string. Can be used to render several times.

Instances

Eq Compiled

Methods

(==) :: Compiled -> Compiled -> Bool

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

Show Compiled

Methods

showsPrec :: Int -> Compiled -> ShowS

show :: Compiled -> String

showList :: [Compiled] -> ShowS

IsString Compiled

Methods

fromString :: String -> Compiled

type Name = Text

The name of a referenced variable.