Modulestache-2.4.0GHC2021

Text.Mustache.Type

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

Synopsis

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

Packagestache-2.4.0
Exports8
LanguageGHC2021
LicenceBSD-3-Clause
SourceType.hs

datadata Template

Source#

Mustache template as the name of the “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
  The name of the currently “selected” template.
- templateCache :: Map PName [Node]
  A 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.

Instances8Eq, Data, Ord, Show, Generic, Semigroup, …

Eq TemplateDefined in stache-2.4.0 · Text.Mustache.Type
Data TemplateDefined in stache-2.4.0 · Text.Mustache.Type
Ord TemplateDefined in stache-2.4.0 · Text.Mustache.Type
Show TemplateDefined in stache-2.4.0 · Text.Mustache.Type
Generic TemplateDefined in stache-2.4.0 · Text.Mustache.Type
Semigroup TemplateDefined in stache-2.4.0 · Text.Mustache.Type
Lift TemplateDefined in stache-2.4.0 · Text.Mustache.Type
type Rep Template = D1 ('MetaData "Template" "Text.Mustache.Type" "stache-2.4.0-2PeV5oxJAuS1hCgCHkMZnc" '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 stache-2.4.0 · Text.Mustache.Type

datadata Node

Source#

A structural element of a 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 Pos)
Partial with indentation level (Nothing means it was inlined)

Instances7Eq, Data, Ord, Show, Generic, Lift, …

Eq NodeDefined in stache-2.4.0 · Text.Mustache.Type
Data NodeDefined in stache-2.4.0 · Text.Mustache.Type
Ord NodeDefined in stache-2.4.0 · Text.Mustache.Type
Show NodeDefined in stache-2.4.0 · Text.Mustache.Type
Generic NodeDefined in stache-2.4.0 · Text.Mustache.Type
Lift NodeDefined in stache-2.4.0 · Text.Mustache.Type
type Rep Node = D1 ('MetaData "Node" "Text.Mustache.Type" "stache-2.4.0-2PeV5oxJAuS1hCgCHkMZnc" '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 Pos))))))Defined in stache-2.4.0 · Text.Mustache.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]

Instances10Eq, Data, Ord, Show, Generic, Semigroup, …

Eq KeyDefined in stache-2.4.0 · Text.Mustache.Type
Data KeyDefined in stache-2.4.0 · Text.Mustache.Type
Ord KeyDefined in stache-2.4.0 · Text.Mustache.Type
Show KeyDefined in stache-2.4.0 · Text.Mustache.Type
Generic KeyDefined in stache-2.4.0 · Text.Mustache.Type
Semigroup KeyDefined in stache-2.4.0 · Text.Mustache.Type
Monoid KeyDefined in stache-2.4.0 · Text.Mustache.Type
NFData KeyDefined in stache-2.4.0 · Text.Mustache.Type
Lift KeyDefined in stache-2.4.0 · Text.Mustache.Type
type Rep Key = D1 ('MetaData "Key" "Text.Mustache.Type" "stache-2.4.0-2PeV5oxJAuS1hCgCHkMZnc" 'True) (C1 ('MetaCons "Key" 'PrefixI 'True) (S1 ('MetaSel ('Just "unKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Text])))Defined in stache-2.4.0 · Text.Mustache.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

Instances9Eq, Data, Ord, Show, IsString, Generic, …

Eq PNameDefined in stache-2.4.0 · Text.Mustache.Type
Data PNameDefined in stache-2.4.0 · Text.Mustache.Type
Ord PNameDefined in stache-2.4.0 · Text.Mustache.Type
Show PNameDefined in stache-2.4.0 · Text.Mustache.Type
IsString PNameDefined in stache-2.4.0 · Text.Mustache.Type
Generic PNameDefined in stache-2.4.0 · Text.Mustache.Type
NFData PNameDefined in stache-2.4.0 · Text.Mustache.Type
Lift PNameDefined in stache-2.4.0 · Text.Mustache.Type
type Rep PName = D1 ('MetaData "PName" "Text.Mustache.Type" "stache-2.4.0-2PeV5oxJAuS1hCgCHkMZnc" 'True) (C1 ('MetaCons "PName" 'PrefixI 'True) (S1 ('MetaSel ('Just "unPName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))Defined in stache-2.4.0 · Text.Mustache.Type

newtypenewtype MustacheException

Source#

Exception that is thrown when parsing of a template fails or referenced values are not provided.

Constructors

MustacheParserException (ParseErrorBundle Text Void)
Template parser has failed. This contains the parse error.
Before version 0.2.0 it was called MustacheException.
The Text field was added in version 1.0.0.

Instances5Eq, Show, Generic, Exception, Rep

Eq MustacheExceptionDefined in stache-2.4.0 · Text.Mustache.Type
Show MustacheExceptionDefined in stache-2.4.0 · Text.Mustache.Type
Generic MustacheExceptionDefined in stache-2.4.0 · Text.Mustache.Type
Exception MustacheExceptionDefined in stache-2.4.0 · Text.Mustache.Type
type Rep MustacheException = D1 ('MetaData "MustacheException" "Text.Mustache.Type" "stache-2.4.0-2PeV5oxJAuS1hCgCHkMZnc" 'True) (C1 ('MetaCons "MustacheParserException" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ParseErrorBundle Text Void))))Defined in stache-2.4.0 · Text.Mustache.Type

datadata MustacheWarning

Source#

Warning that may be generated during rendering of a Template.

Constructors

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

Instances4Eq, Show, Generic, Rep

Eq MustacheWarningDefined in stache-2.4.0 · Text.Mustache.Type
Show MustacheWarningDefined in stache-2.4.0 · Text.Mustache.Type
Generic MustacheWarningDefined in stache-2.4.0 · Text.Mustache.Type
type Rep MustacheWarning = D1 ('MetaData "MustacheWarning" "Text.Mustache.Type" "stache-2.4.0-2PeV5oxJAuS1hCgCHkMZnc" '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 stache-2.4.0 · Text.Mustache.Type

valuedisplayMustacheWarning :: MustacheWarning -> String

Source#

Pretty-print a MustacheWarning.