Text.Mustache.Types

Types for the Parser / Template

type STree = [Node Text]

Syntax tree for a mustache template

data Template

A compiled Template with metadata.

Constructors

Template

Fields

name :: String

ast :: STree

partials :: TemplateCache

Instances

Show Template

data Node α

Basic values composing the STree

Constructors

TextBlock α

Section DataIdentifier STree

InvertedSection DataIdentifier STree

Variable Bool DataIdentifier

Partial (Maybe α) FilePath

Instances

Eq α => Eq (Node α)

Show α => Show (Node α)

ToMustache (Context Value -> STree -> String)

ToMustache (Context Value -> STree -> Text)

ToMustache (Context Value -> STree -> Text)

ToMustache (Context Value -> STree -> STree)

ToMustache (STree -> Text)

ToMustache (STree -> STree)

data DataIdentifier

Kinds of identifiers for Variables and sections

Constructors

NamedData [Key]

Implicit

Instances

Eq DataIdentifier

Show DataIdentifier

Types for the Substitution / Data

data Value

Internal value representation

Constructors

Object Object

Array Array

Number Scientific

String Text

Lambda (Context Value -> STree -> STree)

Bool Bool

Null

Instances

Show Value

ToMustache Value

ToMustache (Context Value -> STree -> String)

ToMustache (Context Value -> STree -> Text)

ToMustache (Context Value -> STree -> Text)

ToMustache (Context Value -> STree -> STree)

type Key = Text

Type of key used for retrieving data from Values

Converting

object :: [Pair] -> Value

Convenience function for creating Object values.

This function is supposed to be used in conjuction with the ~> and ~= operators.

Examples

  data Address = Address { ... }

  instance Address ToJSON where
    ...

  data Person = Person { name :: String, address :: Address }

  instance ToMustache Person where
    toMustache (Person { name, address }) = object
      [ "name" ~> name
      , "address" ~= address
      ]

Here we can see that we can use the ~> operator for values that have themselves a ToMustache instance, or alternatively if they lack such an instance but provide an instance for the ToJSON typeclass we can use the ~= operator.

(~>) :: ToMustache ω => Text -> ω -> Pair infixr 8

Map keys to values that provide a ToMustache instance

Recommended in conjunction with the OverloadedStrings extension.

(↝) :: ToMustache ω => Text -> ω -> Pair infixr 8

Unicode version of ~>

(~=) :: ToJSON ι => Text -> ι -> Pair infixr 8

Map keys to values that provide a ToJSON instance

Recommended in conjunction with the OverloadedStrings extension.

(⥱) :: ToJSON ι => Text -> ι -> Pair infixr 8

Unicode version of ~=

class ToMustache ω where

Conversion class

Methods

toMustache :: ω -> Value

Instances

ToMustache Bool

ToMustache Char

ToMustache Double

ToMustache Float

ToMustache Int

ToMustache Integer

ToMustache ()

ToMustache Scientific

ToMustache Text

ToMustache Value

ToMustache Text

ToMustache Value

ToMustache α => ToMustache [α]

ToMustache ω => ToMustache (HashSet ω)

ToMustache ω => ToMustache (Vector ω)

ToMustache (Context Value -> STree -> String)

ToMustache (Context Value -> STree -> Text)

ToMustache (Context Value -> STree -> Text)

ToMustache (Context Value -> STree -> STree)

ToMustache (STree -> Text)

ToMustache (STree -> STree)

(ToMustache α, ToMustache β) => ToMustache (α, β)

ToMustache ω => ToMustache (HashMap String ω)

ToMustache ω => ToMustache (HashMap Text ω)

ToMustache ω => ToMustache (HashMap Text ω)

ToMustache ω => ToMustache (Map String ω)

ToMustache ω => ToMustache (Map Text ω)

ToMustache ω => ToMustache (Map Text ω)

(ToMustache α, ToMustache β, ToMustache γ) => ToMustache (α, β, γ)

(ToMustache α, ToMustache β, ToMustache γ, ToMustache δ) => ToMustache (α, β, γ, δ)

(ToMustache α, ToMustache β, ToMustache γ, ToMustache δ, ToMustache ε) => ToMustache (α, β, γ, δ, ε)

(ToMustache α, ToMustache β, ToMustache γ, ToMustache δ, ToMustache ε, ToMustache ζ) => ToMustache (α, β, γ, δ, ε, ζ)

(ToMustache α, ToMustache β, ToMustache γ, ToMustache δ, ToMustache ε, ToMustache ζ, ToMustache η) => ToMustache (α, β, γ, δ, ε, ζ, η)

(ToMustache α, ToMustache β, ToMustache γ, ToMustache δ, ToMustache ε, ToMustache ζ, ToMustache η, ToMustache θ) => ToMustache (α, β, γ, δ, ε, ζ, η, θ)

mFromJSON :: ToJSON ι => ι -> Value

Converts a value that can be represented as JSON to a Value.

Representation

type Array = Vector Value

A list-like structure used in Value

type Object = HashMap Text Value

A map-like structure used in Value

type Pair = (Text, Value)

Source type for constructing Objects

data Context α

Representation of stateful context for the substitution process

Constructors

Context [α] α

Instances

Eq α => Eq (Context α)

Ord α => Ord (Context α)

Show α => Show (Context α)

ToMustache (Context Value -> STree -> String)

ToMustache (Context Value -> STree -> Text)

ToMustache (Context Value -> STree -> Text)

ToMustache (Context Value -> STree -> STree)

type TemplateCache = HashMap String Template

A collection of templates with quick access via their hashed names