microstache-1.0.1.1: Mustache templates for Haskell

Copyright© 2016–2017 Stack Buliders
LicenseBSD 3 clause
MaintainerMark Karpov <markkarpov@openmailbox.org>
Stabilityexperimental
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Text.Microstache.Type

Description

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

Documentation

data Template #

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 

Fields

  • 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.

Instances
Eq Template # 
Instance details

Defined in Text.Microstache.Type

Data Template # 
Instance details

Defined in Text.Microstache.Type

Methods

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 :: (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 # 
Instance details

Defined in Text.Microstache.Type

Show Template # 
Instance details

Defined in Text.Microstache.Type

Generic Template # 
Instance details

Defined in Text.Microstache.Type

Associated Types

type Rep Template :: Type -> Type #

Methods

from :: Template -> Rep Template x #

to :: Rep Template x -> Template #

Semigroup Template # 
Instance details

Defined in Text.Microstache.Type

type Rep Template # 
Instance details

Defined in Text.Microstache.Type

type Rep Template = D1 (MetaData "Template" "Text.Microstache.Type" "microstache-1.0.1.1-6kXRO0mFHZB3AWQiJuoUZ8" 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]))))

data Node #

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)

Instances
Eq Node # 
Instance details

Defined in Text.Microstache.Type

Methods

(==) :: Node -> Node -> Bool #

(/=) :: Node -> Node -> Bool #

Data Node # 
Instance details

Defined in Text.Microstache.Type

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Node -> c Node #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Node #

toConstr :: Node -> Constr #

dataTypeOf :: Node -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Node) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Node) #

gmapT :: (forall b. Data b => b -> b) -> Node -> Node #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Node -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Node -> r #

gmapQ :: (forall d. Data d => d -> u) -> Node -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Node -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Node -> m Node #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Node -> m Node #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Node -> m Node #

Ord Node # 
Instance details

Defined in Text.Microstache.Type

Methods

compare :: Node -> Node -> Ordering #

(<) :: Node -> Node -> Bool #

(<=) :: Node -> Node -> Bool #

(>) :: Node -> Node -> Bool #

(>=) :: Node -> Node -> Bool #

max :: Node -> Node -> Node #

min :: Node -> Node -> Node #

Show Node # 
Instance details

Defined in Text.Microstache.Type

Methods

showsPrec :: Int -> Node -> ShowS #

show :: Node -> String #

showList :: [Node] -> ShowS #

Generic Node # 
Instance details

Defined in Text.Microstache.Type

Associated Types

type Rep Node :: Type -> Type #

Methods

from :: Node -> Rep Node x #

to :: Rep Node x -> Node #

type Rep Node # 
Instance details

Defined in Text.Microstache.Type

newtype Key #

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 

Fields

Instances
Eq Key # 
Instance details

Defined in Text.Microstache.Type

Methods

(==) :: Key -> Key -> Bool #

(/=) :: Key -> Key -> Bool #

Data Key # 
Instance details

Defined in Text.Microstache.Type

Methods

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 #

toConstr :: Key -> Constr #

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 :: (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 # 
Instance details

Defined in Text.Microstache.Type

Methods

compare :: Key -> Key -> Ordering #

(<) :: Key -> Key -> Bool #

(<=) :: Key -> Key -> Bool #

(>) :: Key -> Key -> Bool #

(>=) :: Key -> Key -> Bool #

max :: Key -> Key -> Key #

min :: Key -> Key -> Key #

Show Key # 
Instance details

Defined in Text.Microstache.Type

Methods

showsPrec :: Int -> Key -> ShowS #

show :: Key -> String #

showList :: [Key] -> ShowS #

Generic Key # 
Instance details

Defined in Text.Microstache.Type

Associated Types

type Rep Key :: Type -> Type #

Methods

from :: Key -> Rep Key x #

to :: Rep Key x -> Key #

Semigroup Key # 
Instance details

Defined in Text.Microstache.Type

Methods

(<>) :: Key -> Key -> Key #

sconcat :: NonEmpty Key -> Key #

stimes :: Integral b => b -> Key -> Key #

Monoid Key # 
Instance details

Defined in Text.Microstache.Type

Methods

mempty :: Key #

mappend :: Key -> Key -> Key #

mconcat :: [Key] -> Key #

NFData Key # 
Instance details

Defined in Text.Microstache.Type

Methods

rnf :: Key -> () #

type Rep Key # 
Instance details

Defined in Text.Microstache.Type

type Rep Key = D1 (MetaData "Key" "Text.Microstache.Type" "microstache-1.0.1.1-6kXRO0mFHZB3AWQiJuoUZ8" True) (C1 (MetaCons "Key" PrefixI True) (S1 (MetaSel (Just "unKey") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Text])))

showKey :: Key -> Text #

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

newtype PName #

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

Constructors

PName 

Fields

Instances
Eq PName # 
Instance details

Defined in Text.Microstache.Type

Methods

(==) :: PName -> PName -> Bool #

(/=) :: PName -> PName -> Bool #

Data PName # 
Instance details

Defined in Text.Microstache.Type

Methods

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 #

toConstr :: PName -> Constr #

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 :: (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 # 
Instance details

Defined in Text.Microstache.Type

Methods

compare :: PName -> PName -> Ordering #

(<) :: PName -> PName -> Bool #

(<=) :: PName -> PName -> Bool #

(>) :: PName -> PName -> Bool #

(>=) :: PName -> PName -> Bool #

max :: PName -> PName -> PName #

min :: PName -> PName -> PName #

Show PName # 
Instance details

Defined in Text.Microstache.Type

Methods

showsPrec :: Int -> PName -> ShowS #

show :: PName -> String #

showList :: [PName] -> ShowS #

IsString PName # 
Instance details

Defined in Text.Microstache.Type

Methods

fromString :: String -> PName #

Generic PName # 
Instance details

Defined in Text.Microstache.Type

Associated Types

type Rep PName :: Type -> Type #

Methods

from :: PName -> Rep PName x #

to :: Rep PName x -> PName #

NFData PName # 
Instance details

Defined in Text.Microstache.Type

Methods

rnf :: PName -> () #

type Rep PName # 
Instance details

Defined in Text.Microstache.Type

type Rep PName = D1 (MetaData "PName" "Text.Microstache.Type" "microstache-1.0.1.1-6kXRO0mFHZB3AWQiJuoUZ8" True) (C1 (MetaCons "PName" PrefixI True) (S1 (MetaSel (Just "unPName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

data MustacheException #

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

Deprecated: Not thrown anymore, will be removed in the next major version of microstache

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.

Instances
Eq MustacheException # 
Instance details

Defined in Text.Microstache.Type

Show MustacheException # 
Instance details

Defined in Text.Microstache.Type

Generic MustacheException # 
Instance details

Defined in Text.Microstache.Type

Associated Types

type Rep MustacheException :: Type -> Type #

Exception MustacheException # 
Instance details

Defined in Text.Microstache.Type

type Rep MustacheException # 
Instance details

Defined in Text.Microstache.Type

type Rep MustacheException = D1 (MetaData "MustacheException" "Text.Microstache.Type" "microstache-1.0.1.1-6kXRO0mFHZB3AWQiJuoUZ8" False) (C1 (MetaCons "MustacheParserException" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ParseError)) :+: C1 (MetaCons "MustacheRenderException" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PName) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Key)))

data MustacheWarning #

Since: 1.0.1

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

Instances
Eq MustacheWarning # 
Instance details

Defined in Text.Microstache.Type

Show MustacheWarning # 
Instance details

Defined in Text.Microstache.Type

Generic MustacheWarning # 
Instance details

Defined in Text.Microstache.Type

Associated Types

type Rep MustacheWarning :: Type -> Type #

Exception MustacheWarning # 
Instance details

Defined in Text.Microstache.Type

type Rep MustacheWarning # 
Instance details

Defined in Text.Microstache.Type

type Rep MustacheWarning = D1 (MetaData "MustacheWarning" "Text.Microstache.Type" "microstache-1.0.1.1-6kXRO0mFHZB3AWQiJuoUZ8" False) (C1 (MetaCons "MustacheVariableNotFound" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Key)) :+: C1 (MetaCons "MustacheDirectlyRenderedValue" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Key)))