HStringTemplate-0.3.1: StringTemplate implementation in Haskell. Source code Contents Index

Text.StringTemplate.Classes

Synopsis

data SElem a = STR String | STSH STShow | SM (SMap a) | LI [SElem a] | SBLE a | SNull class Show a => StringTemplateShows a where stringTemplateShow :: a -> String stringTemplateFormattedShow :: String -> a -> String class ToSElem a where toSElem :: Stringable b => a -> SElem b toSElemList :: Stringable b => [a] -> SElem b type SMap a = Map String (SElem a) data STShow = forall a . StringTemplateShows a => STShow a newtype StFirst a = StFirst { stGetFirst :: Maybe a } class Monoid a => Stringable a where stFromString :: String -> a stToString :: a -> String mconcatMap :: [b] -> (b -> a) -> a mintercalate :: a -> [a] -> a mlabel :: a -> a -> a stShowsToSE :: (StringTemplateShows a, Stringable b) => a -> SElem b

Documentation

data SElem a Source

Constructors STR String STSH STShow SM (SMap a) LI [SElem a] SBLE 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. Methods stringTemplateShow :: a -> String Source Defaults to show. stringTemplateFormattedShow :: String -> a -> String Source Defaults to _ a -> stringTemplateShow a Instances StringTemplateShows Double StringTemplateShows Float StringTemplateShows LocalTime StringTemplateShows ZonedTime StringTemplateShows TimeOfDay StringTemplateShows TimeZone StringTemplateShows UTCTime StringTemplateShows Day StringTemplateShows CalendarTime StringTemplateShows TimeDiff

class ToSElem a where Source

The ToSElem class should be instantiated for all types that can be inserted as attributes into a StringTemplate. Methods toSElem :: Stringable b => a -> SElem b Source toSElemList :: Stringable b => [a] -> SElem b Source Instances ToSElem Bool ToSElem Char ToSElem Double ToSElem Float ToSElem Int ToSElem Integer ToSElem LocalTime ToSElem ZonedTime ToSElem TimeOfDay ToSElem TimeZone ToSElem UTCTime ToSElem Day ToSElem CalendarTime ToSElem TimeDiff ToSElem a => ToSElem ([] a) Integral a => ToSElem (Ratio a) ToSElem a => ToSElem (Maybe a) (ToSElem a, ToSElem b) => ToSElem ((,) a b) (ToSElem a, Ix i) => ToSElem (Array i a) ToSElem a => ToSElem (Map String a) (ToSElem a, ToSElem b, ToSElem c) => ToSElem ((,,) a b c) (ToSElem a, ToSElem b, ToSElem c, ToSElem d) => ToSElem ((,,,) a b c d) (ToSElem a, ToSElem b, ToSElem c, ToSElem d, ToSElem e) => ToSElem ((,,,,) a b c d e)

type SMap a = Map String (SElem a) Source

data STShow Source

Constructors forall a . StringTemplateShows a => STShow a

newtype StFirst a Source

Constructors StFirst stGetFirst :: Maybe a Instances Functor StFirst Eq a => Eq (StFirst a) Ord a => Ord (StFirst a) Read a => Read (StFirst a) Show a => Show (StFirst a) Monoid (StFirst 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. Methods stFromString :: String -> 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 ]] Instances Stringable Doc Stringable ByteString Stringable ByteString Stringable ([] Char) Stringable (Endo String)

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.

Produced by Haddock version 2.3.0