Text.Mustache.Render

Substitution

substitute :: ToMustache k => Template -> k -> Text

Substitutes all mustache defined tokens (or tags) for values found in the provided data structure.

Equivalent to substituteValue . toMustache.

substituteValue :: Template -> Value -> Text

Substitutes all mustache defined tokens (or tags) for values found in the provided data structure.

Checked substitution

checkedSubstitute :: ToMustache k => Template -> k -> ([SubstitutionError], Text)

Substitutes all mustache defined tokens (or tags) for values found in the provided data structure and report any errors and warnings encountered during substitution.

This function always produces results, as in a fully substituted/rendered template, it never halts on errors. It simply reports them in the first part of the tuple. Sites with errors are usually substituted with empty string.

The second value in the tuple is a template rendered with errors ignored. Therefore if you must enforce that there were no errors during substitution you must check that the error list in the first tuple value is empty.

Equivalent to checkedSubstituteValue . toMustache.

checkedSubstituteValue :: Template -> Value -> ([SubstitutionError], Text)

Substitutes all mustache defined tokens (or tags) for values found in the provided data structure and report any errors and warnings encountered during substitution.

This function always produces results, as in a fully substituted/rendered template, it never halts on errors. It simply reports them in the first part of the tuple. Sites with errors are usually substituted with empty string.

The second value in the tuple is a template rendered with errors ignored. Therefore if you must enforce that there were no errors during substitution you must check that the error list in the first tuple value is empty.

data SubstitutionError

Type of errors we may encounter during substitution.

Constructors

VariableNotFound [Key]

The template contained a variable for which there was no data counterpart in the current context

InvalidImplicitSectionContextType String

When substituting an implicit section the current context had an unsubstitutable type

InvertedImplicitSection

Inverted implicit sections should never occur

SectionTargetNotFound [Key]

The template contained a section for which there was no data counterpart in the current context

PartialNotFound FilePath

The template contained a partial for which there was no data counterpart in the current context

DirectlyRenderedValue Value

A complex value such as an Object or Array was directly rendered into the template (warning)

Instances

Show SubstitutionError

Methods

showsPrec :: Int -> SubstitutionError -> ShowS

show :: SubstitutionError -> String

showList :: [SubstitutionError] -> ShowS

Working with Context

data Context α

Representation of stateful context for the substitution process

Constructors

Context [α] α

Instances

Eq α => Eq (Context α)

Methods

(==) :: Context α -> Context α -> Bool

(/=) :: Context α -> Context α -> Bool

Ord α => Ord (Context α)

Methods

compare :: Context α -> Context α -> Ordering

(<) :: Context α -> Context α -> Bool

(<=) :: Context α -> Context α -> Bool

(>) :: Context α -> Context α -> Bool

(>=) :: Context α -> Context α -> Bool

max :: Context α -> Context α -> Context α

min :: Context α -> Context α -> Context α

Show α => Show (Context α)

Methods

showsPrec :: Int -> Context α -> ShowS

show :: Context α -> String

showList :: [Context α] -> ShowS

ToMustache (Context Value -> STree -> String)

Methods

toMustache :: (Context Value -> STree -> String) -> Value

listToMustache :: [Context Value -> STree -> String] -> Value

ToMustache (Context Value -> STree -> Text)

Methods

toMustache :: (Context Value -> STree -> Text) -> Value

listToMustache :: [Context Value -> STree -> Text] -> Value

ToMustache (Context Value -> STree -> Text)

Methods

toMustache :: (Context Value -> STree -> Text) -> Value

listToMustache :: [Context Value -> STree -> Text] -> Value

ToMustache (Context Value -> STree -> STree)

Methods

toMustache :: (Context Value -> STree -> STree) -> Value

listToMustache :: [Context Value -> STree -> STree] -> Value

search :: Context Value -> [Key] -> Maybe Value

Search for a key in the current context.

The search is conducted inside out mening the current focus is searched first. If the key is not found the outer scopes are recursively searched until the key is found, then innerSearch is called on the result.

innerSearch :: [Key] -> Value -> Maybe Value

Searches nested scopes navigating inward. Fails if it encunters something other than an object before the key is expended.

Util

toString :: Value -> Substitution Text

Converts values to Text as required by the mustache standard