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.

Documentation

data Template

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

Fields

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

Instances

Data Template

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

Semigroup Template

Defined in Text.Mustache.Type

Methods

(<>) :: Template -> Template -> Template

sconcat :: NonEmpty Template -> Template

stimes :: Integral b => b -> Template -> Template

Generic Template

Defined in Text.Mustache.Type

Associated Types

type Rep Template :: Type -> Type

Methods

from :: Template -> Rep Template x

to :: Rep Template x -> Template

Show Template

Defined in Text.Mustache.Type

Methods

showsPrec :: Int -> Template -> ShowS

show :: Template -> String

showList :: [Template] -> ShowS

Eq Template

Defined in Text.Mustache.Type

Methods

(==) :: Template -> Template -> Bool

(/=) :: Template -> Template -> Bool

Ord Template

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

Lift Template

Since: 2.1.0

Defined in Text.Mustache.Type

Methods

lift :: Quote m => Template -> m Exp

liftTyped :: forall (m :: Type -> Type). Quote m => Template -> Code m Template

type Rep Template

Defined in Text.Mustache.Type

type Rep Template = D1 ('MetaData "Template" "Text.Mustache.Type" "stache-2.3.4-inplace" '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

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)

Instances

Data Node

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 :: forall r r'. (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

Generic Node

Defined in Text.Mustache.Type

Associated Types

type Rep Node :: Type -> Type

Methods

from :: Node -> Rep Node x

to :: Rep Node x -> Node

Show Node

Defined in Text.Mustache.Type

Methods

showsPrec :: Int -> Node -> ShowS

show :: Node -> String

showList :: [Node] -> ShowS

Eq Node

Defined in Text.Mustache.Type

Methods

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

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

Ord Node

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

Lift Node

Since: 2.1.0

Defined in Text.Mustache.Type

Methods

lift :: Quote m => Node -> m Exp

liftTyped :: forall (m :: Type -> Type). Quote m => Node -> Code m Node

type Rep Node

Defined in Text.Mustache.Type

type Rep Node = D1 ('MetaData "Node" "Text.Mustache.Type" "stache-2.3.4-inplace" '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

Data Key

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

Monoid Key

Defined in Text.Mustache.Type

Methods

mempty :: Key

mappend :: Key -> Key -> Key

mconcat :: [Key] -> Key

Semigroup Key

Defined in Text.Mustache.Type

Methods

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

sconcat :: NonEmpty Key -> Key

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

Generic Key

Defined in Text.Mustache.Type

Associated Types

type Rep Key :: Type -> Type

Methods

from :: Key -> Rep Key x

to :: Rep Key x -> Key

Show Key

Defined in Text.Mustache.Type

Methods

showsPrec :: Int -> Key -> ShowS

show :: Key -> String

showList :: [Key] -> ShowS

NFData Key

Defined in Text.Mustache.Type

Methods

rnf :: Key -> ()

Eq Key

Defined in Text.Mustache.Type

Methods

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

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

Ord Key

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

Lift Key

Since: 2.1.0

Defined in Text.Mustache.Type

Methods

lift :: Quote m => Key -> m Exp

liftTyped :: forall (m :: Type -> Type). Quote m => Key -> Code m Key

type Rep Key

Defined in Text.Mustache.Type

type Rep Key = D1 ('MetaData "Key" "Text.Mustache.Type" "stache-2.3.4-inplace" '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

Data PName

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

IsString PName

Defined in Text.Mustache.Type

Methods

fromString :: String -> PName

Generic PName

Defined in Text.Mustache.Type

Associated Types

type Rep PName :: Type -> Type

Methods

from :: PName -> Rep PName x

to :: Rep PName x -> PName

Show PName

Defined in Text.Mustache.Type

Methods

showsPrec :: Int -> PName -> ShowS

show :: PName -> String

showList :: [PName] -> ShowS

NFData PName

Defined in Text.Mustache.Type

Methods

rnf :: PName -> ()

Eq PName

Defined in Text.Mustache.Type

Methods

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

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

Ord PName

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

Lift PName

Since: 2.1.0

Defined in Text.Mustache.Type

Methods

lift :: Quote m => PName -> m Exp

liftTyped :: forall (m :: Type -> Type). Quote m => PName -> Code m PName

type Rep PName

Defined in Text.Mustache.Type

type Rep PName = D1 ('MetaData "PName" "Text.Mustache.Type" "stache-2.3.4-inplace" '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

Exception MustacheException

Defined in Text.Mustache.Type

Methods

toException :: MustacheException -> SomeException

fromException :: SomeException -> Maybe MustacheException

displayException :: MustacheException -> String

Generic MustacheException

Defined in Text.Mustache.Type

Associated Types

type Rep MustacheException :: Type -> Type

Methods

from :: MustacheException -> Rep MustacheException x

to :: Rep MustacheException x -> MustacheException

Show MustacheException

Defined in Text.Mustache.Type

Methods

showsPrec :: Int -> MustacheException -> ShowS

show :: MustacheException -> String

showList :: [MustacheException] -> ShowS

Eq MustacheException

Defined in Text.Mustache.Type

Methods

(==) :: MustacheException -> MustacheException -> Bool

(/=) :: MustacheException -> MustacheException -> Bool

type Rep MustacheException

Defined in Text.Mustache.Type

type Rep MustacheException = D1 ('MetaData "MustacheException" "Text.Mustache.Type" "stache-2.3.4-inplace" '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 in the current context.

MustacheDirectlyRenderedValue Key

A complex value such as an Object or Array was directly rendered into the template.

Instances

Generic MustacheWarning

Defined in Text.Mustache.Type

Associated Types

type Rep MustacheWarning :: Type -> Type

Methods

from :: MustacheWarning -> Rep MustacheWarning x

to :: Rep MustacheWarning x -> MustacheWarning

Show MustacheWarning

Defined in Text.Mustache.Type

Methods

showsPrec :: Int -> MustacheWarning -> ShowS

show :: MustacheWarning -> String

showList :: [MustacheWarning] -> ShowS

Eq MustacheWarning

Defined in Text.Mustache.Type

Methods

(==) :: MustacheWarning -> MustacheWarning -> Bool

(/=) :: MustacheWarning -> MustacheWarning -> Bool

type Rep MustacheWarning

Defined in Text.Mustache.Type

type Rep MustacheWarning = D1 ('MetaData "MustacheWarning" "Text.Mustache.Type" "stache-2.3.4-inplace" '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