Heist.SpliceAPI

Deprecated: Use Data.Map.Syntax from the map-syntax package instead

An API implementing a convenient syntax for defining and manipulating splices. This module was born from the observation that a list of tuples is semantically ambiguous about how duplicate keys should be handled. Additionally, the syntax is inherently rather cumbersome and difficult to work with. This API takes advantage of do notation to provide a very light syntax for defining splices while at the same time eliminating the semantic ambiguity of alists.

Here's how you can define splices:

mySplices :: Splices Text
mySplices = do
  "firstName" ## "John"
  "lastName"  ## "Smith"

Documentation

type SplicesM s a = MapSyntaxM Text s a

type Splices s = MapSyntax Text s

Convenient type alies for splices.

noSplices :: Splices s

mapS :: (a -> b) -> Splices a -> Splices b

Maps a function over all the splices.

applyS :: a -> Splices (a -> b) -> Splices b

Applies an argument to a splice function.

($$) :: Splices (a -> b) -> a -> Splices b infixr 0

Infix operator for flip applyS

mapNames :: (Text -> Text) -> Splices a -> Splices a

Maps a function over all the splice names.

prefixSplices :: Text -> Text -> Splices a -> Splices a

Adds a prefix to the tag names for a list of splices. If the existing tag name is empty, then the new tag name is just the prefix. Otherwise the new tag name is the prefix followed by the separator followed by the existing name.

namespaceSplices :: Text -> Splices a -> Splices a

prefixSplices specialized to use a colon as separator in the style of XML namespaces.

module Data.Map.Syntax