HStringTemplate-0.8.5: StringTemplate implementation in Haskell.

Safe HaskellNone
LanguageHaskell98

Text.StringTemplate.Classes

Synopsis

Documentation

data SElem a Source

Constructors

STR String 
BS ByteString 
TXT Text 
STSH STShow 
SM (SMap a) 
LI [SElem a] 
SBLE a 
SNAT a 
SNull 

class Show a => StringTemplateShows a where Source

The StringTemplateShows class should be instantiated for all types that are directly displayed in a StringTemplate, but take an optional format string. Each such type must have an appropriate ToSElem method defined as well.

Minimal complete definition

Nothing

Methods

stringTemplateShow :: a -> String Source

Defaults to show.

stringTemplateFormattedShow :: String -> a -> String Source

Defaults to _ a -> stringTemplateShow a

class ToSElem a where Source

The ToSElem class should be instantiated for all types that can be inserted as attributes into a StringTemplate.

Minimal complete definition

toSElem

Methods

toSElem :: Stringable b => a -> SElem b Source

toSElemList :: Stringable b => [a] -> SElem b Source

type SMap a = Map String (SElem a) Source

data STShow Source

Constructors

forall a . StringTemplateShows a => STShow a 

newtype StFirst a Source

Constructors

StFirst 

Fields

stGetFirst :: Maybe a
 

class Monoid a => Stringable a where Source

The Stringable class should be instantiated with care. Generally, the provided instances should be enough for anything.

Minimal complete definition

stFromString, stToString

Methods

stFromString :: String -> a Source

stFromByteString :: ByteString -> a Source

stFromText :: Text -> a Source

stToString :: a -> String Source

mconcatMap :: [b] -> (b -> a) -> a Source

Defaults to mconcatMap m k = foldr (mappend . k) mempty m

mintercalate :: a -> [a] -> a Source

Defaults to (mconcat .) . intersperse

mlabel :: a -> a -> a Source

Defaults to mlabel x y = mconcat [x, stFromString "[", y, stFromString "]"]

stShowsToSE :: (StringTemplateShows a, Stringable b) => a -> SElem b Source

This method should be used to create ToSElem instances for types defining a custom formatted show function.