Text.Mustache.Types

Types for the Parser / Template

type AST = [Node Text]

Abstract syntax tree for a mustache template

data Template

A compiled Template with metadata.

Constructors

Template

Fields

name :: String

ast :: AST

partials :: TemplateCache

Instances

Show Template

data Node α

Basic values composing the AST

Constructors

TextBlock α

Section DataIdentifier AST

InvertedSection DataIdentifier AST

Variable Bool DataIdentifier

Partial (Maybe α) FilePath

Instances

Eq α => Eq (Node α)

Show α => Show (Node α)

Conversion θ Text => ToMustache (Context Value -> AST -> θ)

ToMustache (Context Value -> AST -> Text)

ToMustache (Context Value -> AST -> AST)

ToMustache (AST -> Text)

ToMustache (AST -> AST)

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 AST

Constructors

Object Object

Array Array

Number Scientific

String Text

Lambda (Context Value -> AST -> AST)

Bool Bool

Null

Instances

Show Value

ToMustache Value

ToMustache (Vector Value)

Conversion θ Text => ToMustache (Context Value -> AST -> θ)

ToMustache (Context Value -> AST -> Text)

ToMustache (Context Value -> AST -> AST)

ToMustache (HashMap Text Value)

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 ~=

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

Conceptually similar to ~> but uses arbitrary String-likes as keys.

(~↝) :: (Conversion ζ Text, ToMustache ω) => ζ -> ω -> Pair infixr 8

Unicde version of ~~>

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

Conceptually similar to ~= but uses arbitrary String-likes as keys.

(~⥱) :: (Conversion ζ Text, ToJSON ι) => ζ -> ι -> Pair infixr 8

Unicode version of ~~=

class ToMustache ω where

Conversion class

Note that some instances of this class overlap delierately to provide maximum flexibility instances while preserving maximum efficiency.

Methods

toMustache :: ω -> Value

Instances

ToMustache Bool

ToMustache Char

ToMustache ()

ToMustache Scientific

ToMustache Text

ToMustache Value

ToMustache Text

ToMustache Value

ToMustache [Char]

ToMustache ω => ToMustache [ω]

ToMustache ω => ToMustache (HashSet ω)

ToMustache ω => ToMustache (Vector ω)

ToMustache (Vector Value)

Conversion θ Text => ToMustache (Context Value -> AST -> θ)

ToMustache (Context Value -> AST -> Text)

ToMustache (Context Value -> AST -> AST)

ToMustache (AST -> Text)

ToMustache (AST -> AST)

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

(Conversion θ Text, ToMustache ω) => ToMustache (HashMap θ ω)

ToMustache ω => ToMustache (HashMap Text ω)

ToMustache (HashMap Text Value)

(Conversion θ Text, ToMustache ω) => ToMustache (Map θ ω)

(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 (α, β, γ, δ, ε, ζ, η, θ)

toTextBlock :: Conversion ζ Text => ζ -> Value

Converts arbitrary String-likes to Values

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 α)

Conversion θ Text => ToMustache (Context Value -> AST -> θ)

ToMustache (Context Value -> AST -> Text)

ToMustache (Context Value -> AST -> AST)

type TemplateCache = HashMap String Template

A collection of templates with quick access via their hashed names