Copyright | © 2016–present Stack Buliders |
---|---|
License | BSD 3 clause |
Maintainer | Mark Karpov <markkarpov92@gmail.com> |
Stability | experimental |
Portability | portable |
Safe Haskell | None |
Language | Haskell2010 |
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 = Template {
- templateActual :: PName
- templateCache :: Map PName [Node]
- data Node
- newtype Key = Key {}
- showKey :: Key -> Text
- newtype PName = PName {}
- newtype MustacheException = MustacheParserException (ParseErrorBundle Text Void)
- data MustacheWarning
- displayMustacheWarning :: MustacheWarning -> String
Documentation
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 Template
s
(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.
Template | |
|
Instances
Eq Template Source # | |
Data Template Source # | |
Defined in Text.Mustache.Type gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Template -> c Template # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Template # toConstr :: Template -> Constr # dataTypeOf :: Template -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Template) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Template) # gmapT :: (forall b. Data b => b -> b) -> Template -> Template # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Template -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Template -> r # gmapQ :: (forall d. Data d => d -> u) -> Template -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Template -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Template -> m Template # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Template -> m Template # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Template -> m Template # | |
Ord Template Source # | |
Defined in Text.Mustache.Type | |
Show Template Source # | |
Generic Template Source # | |
Semigroup Template Source # | |
Lift Template Source # | Since: 2.1.0 |
type Rep Template Source # | |
Defined in Text.Mustache.Type type Rep Template = D1 ('MetaData "Template" "Text.Mustache.Type" "stache-2.3.0-KST2L0NBnzl32MqQKo3gl0" '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])))) |
A structural element of a template.
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 ( |
Instances
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.
Instances
Eq Key Source # | |
Data Key Source # | |
Defined in Text.Mustache.Type gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Key -> c Key # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Key # dataTypeOf :: Key -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Key) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Key) # gmapT :: (forall b. Data b => b -> b) -> Key -> Key # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Key -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Key -> r # gmapQ :: (forall d. Data d => d -> u) -> Key -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Key -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Key -> m Key # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Key -> m Key # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Key -> m Key # | |
Ord Key Source # | |
Show Key Source # | |
Generic Key Source # | |
Semigroup Key Source # | |
Monoid Key Source # | |
NFData Key Source # | |
Defined in Text.Mustache.Type | |
Lift Key Source # | Since: 2.1.0 |
type Rep Key Source # | |
Defined in Text.Mustache.Type |
showKey :: Key -> Text Source #
Pretty-print a key. This is helpful, for example, if you want to display an error message.
Since: 0.2.0
Identifier for partials. Note that with the OverloadedStrings
extension you can use just string literals to create values of this type.
Instances
Eq PName Source # | |
Data PName Source # | |
Defined in Text.Mustache.Type gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PName -> c PName # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PName # dataTypeOf :: PName -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c PName) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PName) # gmapT :: (forall b. Data b => b -> b) -> PName -> PName # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PName -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PName -> r # gmapQ :: (forall d. Data d => d -> u) -> PName -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> PName -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> PName -> m PName # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PName -> m PName # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PName -> m PName # | |
Ord PName Source # | |
Show PName Source # | |
IsString PName Source # | |
Defined in Text.Mustache.Type fromString :: String -> PName # | |
Generic PName Source # | |
NFData PName Source # | |
Defined in Text.Mustache.Type | |
Lift PName Source # | Since: 2.1.0 |
type Rep PName Source # | |
Defined in Text.Mustache.Type |
newtype MustacheException Source #
Exception that is thrown when parsing of a template fails or referenced values are not provided.
MustacheParserException (ParseErrorBundle Text Void) | Template parser has failed. This contains the parse error. Before version 0.2.0 it was called The |
Instances
data MustacheWarning Source #
Warning that may be generated during rendering of a Template
.
Since: 1.1.1
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 |
Instances
displayMustacheWarning :: MustacheWarning -> String Source #
Pretty-print a MustacheWarning
.
Since: 1.1.1