| Copyright | (c) 2019-2022 Vaclav Svejcar |
|---|---|
| License | BSD-3-Clause |
| Maintainer | vaclav.svejcar@gmail.com |
| Stability | experimental |
| Portability | POSIX |
| Safe Haskell | None |
| Language | Haskell2010 |
Headroom.Template
Description
Module providing interface for working with template files in extensible way.
Supported template is represented by the Template type class.
Synopsis
- class Template a where
- templateExtensions :: NonEmpty Text
- parseTemplate :: MonadThrow m => TemplateRef -> Text -> m a
- renderTemplate :: MonadThrow m => Variables -> a -> m Text
- rawTemplate :: a -> Text
- templateRef :: a -> TemplateRef
- emptyTemplate :: (MonadThrow m, Template a) => m a
- data TemplateError
Extendable Template Support
class Template a where Source #
Type class representing supported template file.
Methods
Returns list of supported file extensions for this template type.
Arguments
| :: MonadThrow m | |
| => TemplateRef | reference to template source |
| -> Text | raw template text |
| -> m a | parsed template |
Parses template from given raw text.
Arguments
| :: MonadThrow m | |
| => Variables | values of variables to replace |
| -> a | parsed template to render |
| -> m Text | rendered template text |
Renders parsed template and replaces all variables with actual values.
Arguments
| :: a | template for which to return raw template text |
| -> Text | raw template text |
Returns the raw text of the template, same that has been parsed by
parseTemplate method.
Arguments
| :: a | template for which to return reference |
| -> TemplateRef | template reference |
Returns a reference to template source, from which this template was loaded.
Instances
| Template Mustache Source # | Support for Mustache templates. |
Defined in Headroom.Template.Mustache Methods templateExtensions :: NonEmpty Text Source # parseTemplate :: MonadThrow m => TemplateRef -> Text -> m Mustache Source # renderTemplate :: MonadThrow m => Variables -> Mustache -> m Text Source # rawTemplate :: Mustache -> Text Source # templateRef :: Mustache -> TemplateRef Source # | |
Helper Functions
emptyTemplate :: (MonadThrow m, Template a) => m a Source #
Returns empty template of selected type.
Error Data Types
data TemplateError Source #
Error during processing template.
Constructors
| MissingVariables Text [Text] | missing variable values |
| ParseError Text | error parsing raw template text |
Instances
| Eq TemplateError Source # | |
Defined in Headroom.Template Methods (==) :: TemplateError -> TemplateError -> Bool # (/=) :: TemplateError -> TemplateError -> Bool # | |
| Show TemplateError Source # | |
Defined in Headroom.Template Methods showsPrec :: Int -> TemplateError -> ShowS # show :: TemplateError -> String # showList :: [TemplateError] -> ShowS # | |
| Exception TemplateError Source # | |
Defined in Headroom.Template Methods toException :: TemplateError -> SomeException # fromException :: SomeException -> Maybe TemplateError # displayException :: TemplateError -> String # | |