Modulemicrostache-1.0.3.1Haskell2010

Text.Microstache.Type

Types used by the package. You don't usually need to import the module, because Text.Microstache re-exports everything you may need, import that module instead.

Synopsis

data Template
data Node
newtype Key
value showKey
newtype PName
data MustacheException
value displayMustacheException
data MustacheWarning
value displayMustacheWarning

Packagemicrostache-1.0.3.1
Exports9
LanguageHaskell2010
LicenceBSD-3-Clause
SourceType.hs

datadata Template

Source#

Mustache template as name of “top-level” template and a collection of all available templates (partials).

Template is a Semigroup. This means that you can combine Templates (and their caches) using the (<>) operator, the resulting Template will have the same currently selected template as the left one. Union of caches is also left-biased.

Constructors

Template
- templateActual :: PName
  Name of currently “selected” template (top-level one).
- templateCache :: Map PName [Node]
  Collection of all templates that are available for interpolation (as partials). The top-level one is also contained here and the “focus” can be switched easily by modifying templateActual.

Instances7Eq, Data, Ord, Show, Generic, Semigroup, …

Eq TemplateDefined in microstache-1.0.3.1 · Text.Microstache.Type
Data TemplateDefined in microstache-1.0.3.1 · Text.Microstache.Type
Ord TemplateDefined in microstache-1.0.3.1 · Text.Microstache.Type
Show TemplateDefined in microstache-1.0.3.1 · Text.Microstache.Type
Generic TemplateDefined in microstache-1.0.3.1 · Text.Microstache.Type
Semigroup TemplateDefined in microstache-1.0.3.1 · Text.Microstache.Type
type Rep Template = D1 ('MetaData "Template" "Text.Microstache.Type" "microstache-1.0.3.1-C318RVXLY9T9Q4MSK8ifSR" 'False) (C1 ('MetaCons "Template" 'PrefixI 'True) (S1 ('MetaSel ('Just "templateActual") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PName) :*: S1 ('MetaSel ('Just "templateCache") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map PName [Node]))))Defined in microstache-1.0.3.1 · Text.Microstache.Type

datadata Node

Source#

Structural element of template.

Constructors

TextBlock Text
Plain text contained between tags
EscapedVar Key
HTML-escaped variable
UnescapedVar Key
Unescaped variable
Section Key [Node]
Mustache section
InvertedSection Key [Node]
Inverted section
Partial PName (Maybe Word)
Partial with indentation level (Nothing means it was inlined)

Instances6Eq, Data, Ord, Show, Generic, Rep

Eq NodeDefined in microstache-1.0.3.1 · Text.Microstache.Type
Data NodeDefined in microstache-1.0.3.1 · Text.Microstache.Type
Ord NodeDefined in microstache-1.0.3.1 · Text.Microstache.Type
Show NodeDefined in microstache-1.0.3.1 · Text.Microstache.Type
Generic NodeDefined in microstache-1.0.3.1 · Text.Microstache.Type
type Rep Node = D1 ('MetaData "Node" "Text.Microstache.Type" "microstache-1.0.3.1-C318RVXLY9T9Q4MSK8ifSR" 'False) ((C1 ('MetaCons "TextBlock" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: (C1 ('MetaCons "EscapedVar" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Key)) :+: C1 ('MetaCons "UnescapedVar" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Key)))) :+: (C1 ('MetaCons "Section" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Key) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Node])) :+: (C1 ('MetaCons "InvertedSection" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Key) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Node])) :+: C1 ('MetaCons "Partial" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PName) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Word))))))Defined in microstache-1.0.3.1 · Text.Microstache.Type

newtypenewtype Key

Source#

Identifier for values to interpolate.

The representation is the following:

[] — empty list means implicit iterators;
[text] — single key is a normal identifier;
[text1, text2] — multiple keys represent dotted names.

Constructors

Key
- unKey :: [Text]

Instances9Eq, Data, Ord, Show, Generic, Semigroup, …

Eq KeyDefined in microstache-1.0.3.1 · Text.Microstache.Type
Data KeyDefined in microstache-1.0.3.1 · Text.Microstache.Type
Ord KeyDefined in microstache-1.0.3.1 · Text.Microstache.Type
Show KeyDefined in microstache-1.0.3.1 · Text.Microstache.Type
Generic KeyDefined in microstache-1.0.3.1 · Text.Microstache.Type
Semigroup KeyDefined in microstache-1.0.3.1 · Text.Microstache.Type
Monoid KeyDefined in microstache-1.0.3.1 · Text.Microstache.Type
NFData KeyDefined in microstache-1.0.3.1 · Text.Microstache.Type
type Rep Key = D1 ('MetaData "Key" "Text.Microstache.Type" "microstache-1.0.3.1-C318RVXLY9T9Q4MSK8ifSR" 'True) (C1 ('MetaCons "Key" 'PrefixI 'True) (S1 ('MetaSel ('Just "unKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Text])))Defined in microstache-1.0.3.1 · Text.Microstache.Type

valueshowKey :: Key -> Text

Source#

Pretty-print a key, this is helpful, for example, if you want to display an error message.

newtypenewtype PName

Source#

Identifier for partials. Note that with the OverloadedStrings extension you can use just string literals to create values of this type.

Constructors

PName
- unPName :: Text

Instances8Eq, Data, Ord, Show, IsString, Generic, …

Eq PNameDefined in microstache-1.0.3.1 · Text.Microstache.Type
Data PNameDefined in microstache-1.0.3.1 · Text.Microstache.Type
Ord PNameDefined in microstache-1.0.3.1 · Text.Microstache.Type
Show PNameDefined in microstache-1.0.3.1 · Text.Microstache.Type
IsString PNameDefined in microstache-1.0.3.1 · Text.Microstache.Type
Generic PNameDefined in microstache-1.0.3.1 · Text.Microstache.Type
NFData PNameDefined in microstache-1.0.3.1 · Text.Microstache.Type
type Rep PName = D1 ('MetaData "PName" "Text.Microstache.Type" "microstache-1.0.3.1-C318RVXLY9T9Q4MSK8ifSR" 'True) (C1 ('MetaCons "PName" 'PrefixI 'True) (S1 ('MetaSel ('Just "unPName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))Defined in microstache-1.0.3.1 · Text.Microstache.Type

datadata MustacheException

Source#

Exception that is thrown when parsing of a template has failed or referenced values were not provided.

Constructors

MustacheParserException ParseError
Template parser has failed. This contains the parse error.
MustacheRenderException PName Key
A referenced value was not provided. The exception provides info about partial in which the issue happened PName and name of the missing key Key.

Instances5Eq, Show, Generic, Exception, Rep

Eq MustacheExceptionDefined in microstache-1.0.3.1 · Text.Microstache.Type
Show MustacheExceptionDefined in microstache-1.0.3.1 · Text.Microstache.Type
Generic MustacheExceptionDefined in microstache-1.0.3.1 · Text.Microstache.Type
Exception MustacheExceptionDefined in microstache-1.0.3.1 · Text.Microstache.Type
type Rep MustacheException = D1 ('MetaData "MustacheException" "Text.Microstache.Type" "microstache-1.0.3.1-C318RVXLY9T9Q4MSK8ifSR" 'False) (C1 ('MetaCons "MustacheParserException" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ParseError)) :+: C1 ('MetaCons "MustacheRenderException" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PName) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Key)))Defined in microstache-1.0.3.1 · Text.Microstache.Type

valuedisplayMustacheException :: MustacheException -> String

Source#

datadata MustacheWarning

Source#

Constructors

MustacheVariableNotFound Key
The template contained a variable for which there was no data counterpart in the current context
MustacheDirectlyRenderedValue Key
A complex value such as an Object or Array was directly rendered into the template

Instances5Eq, Show, Generic, Exception, Rep

Eq MustacheWarningDefined in microstache-1.0.3.1 · Text.Microstache.Type
Show MustacheWarningDefined in microstache-1.0.3.1 · Text.Microstache.Type
Generic MustacheWarningDefined in microstache-1.0.3.1 · Text.Microstache.Type
Exception MustacheWarningDefined in microstache-1.0.3.1 · Text.Microstache.Type
type Rep MustacheWarning = D1 ('MetaData "MustacheWarning" "Text.Microstache.Type" "microstache-1.0.3.1-C318RVXLY9T9Q4MSK8ifSR" 'False) (C1 ('MetaCons "MustacheVariableNotFound" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Key)) :+: C1 ('MetaCons "MustacheDirectlyRenderedValue" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Key)))Defined in microstache-1.0.3.1 · Text.Microstache.Type

valuedisplayMustacheWarning :: MustacheWarning -> String

Source#