Copyright	© 2016–2018 Stack Buliders
License	BSD 3 clause
Maintainer	Mark Karpov <markkarpov92@gmail.com>
Stability	experimental
Portability	portable
Safe Haskell	None
Language	Haskell2010

Text.Mustache.Type

Description

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
- = TextBlock Text
- | EscapedVar Key
- | UnescapedVar Key
- | Section Key [Node]
- | InvertedSection Key [Node]
- | Partial PName (Maybe Pos)
newtype Key = Key {
- unKey :: [Text]
}
showKey :: Key -> Text
newtype PName = PName {
- unPName :: Text
}
newtype MustacheException = MustacheParserException (ParseErrorBundle Text Void)
data MustacheWarning
- = MustacheVariableNotFound Key
- | MustacheDirectlyRenderedValue Key
displayMustacheWarning :: MustacheWarning -> String

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.Mustache.Type Methods (==) :: Template -> Template -> Bool # (/=) :: Template -> Template -> Bool #
Data Template #
Instance details Defined in Text.Mustache.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.Mustache.Type Methods compare :: Template -> Template -> Ordering # (<) :: Template -> Template -> Bool # (<=) :: Template -> Template -> Bool # (>) :: Template -> Template -> Bool # (>=) :: Template -> Template -> Bool # max :: Template -> Template -> Template # min :: Template -> Template -> Template #
Show Template #
Instance details Defined in Text.Mustache.Type Methods showsPrec :: Int -> Template -> ShowS # show :: Template -> String # showList :: [Template] -> ShowS #
Generic Template #
Instance details Defined in Text.Mustache.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.Mustache.Type Methods (<>) :: Template -> Template -> Template # sconcat :: NonEmpty Template -> Template # stimes :: Integral b => b -> Template -> Template #
type Rep Template #
Instance details Defined in Text.Mustache.Type type Rep Template = D1 (MetaData "Template" "Text.Mustache.Type" "stache-2.0.1-9SfXUpcdOqBFEJZmgbWjw" 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 Pos)	Partial with indentation level (`Nothing` means it was inlined)

Instances

Eq Node #
Instance details Defined in Text.Mustache.Type Methods (==) :: Node -> Node -> Bool # (/=) :: Node -> Node -> Bool #
Data Node #
Instance details Defined in Text.Mustache.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.Mustache.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.Mustache.Type Methods showsPrec :: Int -> Node -> ShowS # show :: Node -> String # showList :: [Node] -> ShowS #
Generic Node #
Instance details Defined in Text.Mustache.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.Mustache.Type type Rep Node = D1 (MetaData "Node" "Text.Mustache.Type" "stache-2.0.1-9SfXUpcdOqBFEJZmgbWjw" False) ((C1 (MetaCons "TextBlock" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)) :+: (C1 (MetaCons "EscapedVar" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Key)) :+: C1 (MetaCons "UnescapedVar" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Key)))) :+: (C1 (MetaCons "Section" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Key) :: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Node])) :+: (C1 (MetaCons "InvertedSection" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Key) :: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Node])) :+: C1 (MetaCons "Partial" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PName) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Pos))))))

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 unKey :: [Text]

Instances

Eq Key #
Instance details Defined in Text.Mustache.Type Methods (==) :: Key -> Key -> Bool # (/=) :: Key -> Key -> Bool #
Data Key #
Instance details Defined in Text.Mustache.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.Mustache.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.Mustache.Type Methods showsPrec :: Int -> Key -> ShowS # show :: Key -> String # showList :: [Key] -> ShowS #
Generic Key #
Instance details Defined in Text.Mustache.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.Mustache.Type Methods (<>) :: Key -> Key -> Key # sconcat :: NonEmpty Key -> Key # stimes :: Integral b => b -> Key -> Key #
Monoid Key #
Instance details Defined in Text.Mustache.Type Methods mempty :: Key # mappend :: Key -> Key -> Key # mconcat :: [Key] -> Key #
NFData Key #
Instance details Defined in Text.Mustache.Type Methods rnf :: Key -> () #
type Rep Key #
Instance details Defined in Text.Mustache.Type type Rep Key = D1 (MetaData "Key" "Text.Mustache.Type" "stache-2.0.1-9SfXUpcdOqBFEJZmgbWjw" 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.

Since: 0.2.0

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 unPName :: Text

Instances

Eq PName #
Instance details Defined in Text.Mustache.Type Methods (==) :: PName -> PName -> Bool # (/=) :: PName -> PName -> Bool #
Data PName #
Instance details Defined in Text.Mustache.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.Mustache.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.Mustache.Type Methods showsPrec :: Int -> PName -> ShowS # show :: PName -> String # showList :: [PName] -> ShowS #
IsString PName #
Instance details Defined in Text.Mustache.Type Methods fromString :: String -> PName #
Generic PName #
Instance details Defined in Text.Mustache.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.Mustache.Type Methods rnf :: PName -> () #
type Rep PName #
Instance details Defined in Text.Mustache.Type type Rep PName = D1 (MetaData "PName" "Text.Mustache.Type" "stache-2.0.1-9SfXUpcdOqBFEJZmgbWjw" True) (C1 (MetaCons "PName" PrefixI True) (S1 (MetaSel (Just "unPName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

newtype MustacheException #

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.

Instances

Eq MustacheException #
Instance details Defined in Text.Mustache.Type Methods (==) :: MustacheException -> MustacheException -> Bool # (/=) :: MustacheException -> MustacheException -> Bool #
Show MustacheException #
Instance details Defined in Text.Mustache.Type Methods showsPrec :: Int -> MustacheException -> ShowS # show :: MustacheException -> String # showList :: [MustacheException] -> ShowS #
Generic MustacheException #
Instance details Defined in Text.Mustache.Type Associated Types type Rep MustacheException :: Type -> Type # Methods from :: MustacheException -> Rep MustacheException x # to :: Rep MustacheException x -> MustacheException #
Exception MustacheException #
Instance details Defined in Text.Mustache.Type Methods toException :: MustacheException -> SomeException # fromException :: SomeException -> Maybe MustacheException # displayException :: MustacheException -> String #
type Rep MustacheException #
Instance details Defined in Text.Mustache.Type type Rep MustacheException = D1 (MetaData "MustacheException" "Text.Mustache.Type" "stache-2.0.1-9SfXUpcdOqBFEJZmgbWjw" True) (C1 (MetaCons "MustacheParserException" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (ParseErrorBundle Text Void))))

data MustacheWarning #

Warning that may be generated during rendering of a Template.

Since: 1.1.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.Mustache.Type Methods (==) :: MustacheWarning -> MustacheWarning -> Bool # (/=) :: MustacheWarning -> MustacheWarning -> Bool #
Show MustacheWarning #
Instance details Defined in Text.Mustache.Type Methods showsPrec :: Int -> MustacheWarning -> ShowS # show :: MustacheWarning -> String # showList :: [MustacheWarning] -> ShowS #
Generic MustacheWarning #
Instance details Defined in Text.Mustache.Type Associated Types type Rep MustacheWarning :: Type -> Type # Methods from :: MustacheWarning -> Rep MustacheWarning x # to :: Rep MustacheWarning x -> MustacheWarning #
type Rep MustacheWarning #
Instance details Defined in Text.Mustache.Type type Rep MustacheWarning = D1 (MetaData "MustacheWarning" "Text.Mustache.Type" "stache-2.0.1-9SfXUpcdOqBFEJZmgbWjw" 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)))

displayMustacheWarning :: MustacheWarning -> String #

Pretty-print a MustacheWarning.

Since: 1.1.1