Text.StringTemplate.Classes

Documentation

data SElem a

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

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

Defaults to show.

stringTemplateFormattedShow :: String -> a -> String

Defaults to _ a -> stringTemplateShow a

class ToSElem a where

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

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

type SMap a = Map String (SElem a)

data STShow

Constructors

StringTemplateShows a => STShow a

newtype StFirst a

Constructors

StFirst

Fields

• stGetFirst :: Maybe a

Instances

Functor StFirst

Methods

fmap :: (a -> b) -> StFirst a -> StFirst b

(<$) :: a -> StFirst b -> StFirst a

Eq a => Eq (StFirst a)

Methods

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

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

Ord a => Ord (StFirst a)

Methods

compare :: StFirst a -> StFirst a -> Ordering

(<) :: StFirst a -> StFirst a -> Bool

(<=) :: StFirst a -> StFirst a -> Bool

(>) :: StFirst a -> StFirst a -> Bool

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

max :: StFirst a -> StFirst a -> StFirst a

min :: StFirst a -> StFirst a -> StFirst a

Read a => Read (StFirst a)

Methods

readsPrec :: Int -> ReadS (StFirst a)

readList :: ReadS [StFirst a]

readPrec :: ReadPrec (StFirst a)

readListPrec :: ReadPrec [StFirst a]

Show a => Show (StFirst a)

Methods

showsPrec :: Int -> StFirst a -> ShowS

show :: StFirst a -> String

showList :: [StFirst a] -> ShowS

Monoid (StFirst a)

Methods

mempty :: StFirst a

mappend :: StFirst a -> StFirst a -> StFirst a

mconcat :: [StFirst a] -> StFirst a

class Monoid a => Stringable a where

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

stFromByteString :: ByteString -> a

stFromText :: Text -> a

stToString :: a -> String

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

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

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

Defaults to (mconcat .) . intersperse

mlabel :: a -> a -> a

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

Instances

Stringable String

Methods

stFromString :: String -> String

stFromByteString :: ByteString -> String

stFromText :: Text -> String

stToString :: String -> String

mconcatMap :: [b] -> (b -> String) -> String

mintercalate :: String -> [String] -> String

mlabel :: String -> String -> String

Stringable ByteString

Methods

stFromString :: String -> ByteString

stFromByteString :: ByteString -> ByteString

stFromText :: Text -> ByteString

stToString :: ByteString -> String

mconcatMap :: [b] -> (b -> ByteString) -> ByteString

mintercalate :: ByteString -> [ByteString] -> ByteString

mlabel :: ByteString -> ByteString -> ByteString

Stringable ByteString

Methods

stFromString :: String -> ByteString

stFromByteString :: ByteString -> ByteString

stFromText :: Text -> ByteString

stToString :: ByteString -> String

mconcatMap :: [b] -> (b -> ByteString) -> ByteString

mintercalate :: ByteString -> [ByteString] -> ByteString

mlabel :: ByteString -> ByteString -> ByteString

Stringable Builder

Methods

stFromString :: String -> Builder

stFromByteString :: ByteString -> Builder

stFromText :: Text -> Builder

stToString :: Builder -> String

mconcatMap :: [b] -> (b -> Builder) -> Builder

mintercalate :: Builder -> [Builder] -> Builder

mlabel :: Builder -> Builder -> Builder

Stringable Text

Methods

stFromString :: String -> Text

stFromByteString :: ByteString -> Text

stFromText :: Text -> Text

stToString :: Text -> String

mconcatMap :: [b] -> (b -> Text) -> Text

mintercalate :: Text -> [Text] -> Text

mlabel :: Text -> Text -> Text

Stringable Text

Methods

stFromString :: String -> Text

stFromByteString :: ByteString -> Text

stFromText :: Text -> Text

stToString :: Text -> String

mconcatMap :: [b] -> (b -> Text) -> Text

mintercalate :: Text -> [Text] -> Text

mlabel :: Text -> Text -> Text

Stringable Doc

Methods

stFromString :: String -> Doc

stFromByteString :: ByteString -> Doc

stFromText :: Text -> Doc

stToString :: Doc -> String

mconcatMap :: [b] -> (b -> Doc) -> Doc

mintercalate :: Doc -> [Doc] -> Doc

mlabel :: Doc -> Doc -> Doc

Stringable Builder

Methods

stFromString :: String -> Builder

stFromByteString :: ByteString -> Builder

stFromText :: Text -> Builder

stToString :: Builder -> String

mconcatMap :: [b] -> (b -> Builder) -> Builder

mintercalate :: Builder -> [Builder] -> Builder

mlabel :: Builder -> Builder -> Builder

Stringable (Endo String)

Methods

stFromString :: String -> Endo String

stFromByteString :: ByteString -> Endo String

stFromText :: Text -> Endo String

stToString :: Endo String -> String

mconcatMap :: [b] -> (b -> Endo String) -> Endo String

mintercalate :: Endo String -> [Endo String] -> Endo String

mlabel :: Endo String -> Endo String -> Endo String

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

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