Safe Haskell | Safe-Inferred |
---|---|
Language | Haskell2010 |
Text.Shakespeare.Text
Description
A Shakespearean module for general text processing, introducing type-safe, compile-time variable interpolation.
Text templates use the same parser as for other shakespearean templates
which enables variable interpolation using #{..}
. The parser also
recognize the @{..}
and ^{..}
syntax.
If it is necessary that your template produces the output containing one of the interpolation syntax you can escape the sequence using a backslash:
λ> :set -XQuasiQuotes λ> let bar = 23 :: Int in [st|#{bar}|] :: Text
produces "23", but
λ> let bar = 23 :: Int in [st|#\{bar}|] :: Text
returns "#{bar}". The escaping backslash is removed from the output.
Further reading: Shakespearean templates: https://www.yesodweb.com/book/shakespearean-templates
Synopsis
- type TextUrl url = RenderUrl url -> Builder
- class ToText a where
- toText :: a -> Builder
- renderTextUrl :: RenderUrl url -> TextUrl url -> Text
- stext :: QuasiQuoter
- stextFile :: FilePath -> Q Exp
- text :: QuasiQuoter
- textFile :: FilePath -> Q Exp
- textFileDebug :: FilePath -> Q Exp
- textFileReload :: FilePath -> Q Exp
- st :: QuasiQuoter
- lt :: QuasiQuoter
- sbt :: QuasiQuoter
- lbt :: QuasiQuoter
- codegen :: QuasiQuoter
- codegenSt :: QuasiQuoter
- codegenFile :: FilePath -> Q Exp
- codegenFileReload :: FilePath -> Q Exp
Documentation
Instances
ToText Int32 Source # | |
Defined in Text.Shakespeare.Text | |
ToText Int64 Source # | |
Defined in Text.Shakespeare.Text | |
ToText Text Source # | |
Defined in Text.Shakespeare.Text | |
ToText Builder Source # | |
Defined in Text.Shakespeare.Text | |
ToText Text Source # | |
Defined in Text.Shakespeare.Text | |
ToText Int Source # | |
Defined in Text.Shakespeare.Text | |
ToText [Char] Source # | |
Defined in Text.Shakespeare.Text |
renderTextUrl :: RenderUrl url -> TextUrl url -> Text Source #
stextFile :: FilePath -> Q Exp Source #
Like stext
, but reads an external file at compile-time.
Since: 2.0.22
textFileDebug :: FilePath -> Q Exp Source #
Deprecated: Please use textFileReload instead
textFileReload :: FilePath -> Q Exp Source #
strict text
lazy text, same as stext :)
strict text whose left edge is aligned with bar ('|')
lazy text, whose left edge is aligned with bar ('|') * Yesod code generation
codegen :: QuasiQuoter Source #
codegen is designed for generating Yesod code, including templates So it uses different interpolation characters that won't clash with templates. You can use the normal text quasiquoters to generate code
codegenSt :: QuasiQuoter Source #
Generates strict Text codegen is designed for generating Yesod code, including templates So it uses different interpolation characters that won't clash with templates.
codegenFile :: FilePath -> Q Exp Source #
codegenFileReload :: FilePath -> Q Exp Source #