Modulehakyll-4.17.0.0Haskell2010

Hakyll.Core.Compiler

Synopsis

newtype Compiler
value getUnderlying
value getUnderlyingExtension
value makeItem
value getRoute
value getResourceBody
value getResourceString
value getResourceLBS
value getResourceFilePath
type Snapshot
value saveSnapshot
value load
value loadSnapshot
value loadBody
value loadSnapshotBody
value loadAll
value loadAllSnapshots
value cached
value recompilingUnsafeCompiler
value unsafeCompiler
value debugCompiler
value noResult
value withErrorMessage

Packagehakyll-4.17.0.0
Exports23
LanguageHaskell2010
LicenceBSD-3-Clause
SourceInternal.hs

newtypenewtype Compiler a

Source#

A monad which lets you compile items and takes care of dependency tracking for you.

Instances7Monad, Functor, MonadFail, Applicative, Alternative, MonadMetadata, …

Monad CompilerDefined in hakyll-4.17.0.0 · Hakyll.Core.Compiler.Internal
Functor CompilerDefined in hakyll-4.17.0.0 · Hakyll.Core.Compiler.Internal
MonadFail CompilerDefined in hakyll-4.17.0.0 · Hakyll.Core.Compiler.Internal
Applicative CompilerDefined in hakyll-4.17.0.0 · Hakyll.Core.Compiler.Internal
Alternative CompilerDefined in hakyll-4.17.0.0 · Hakyll.Core.Compiler.Internal
Trying alternative compilers if the first fails, regardless whether through fail, throwError or noResult. Aggregates error messages if all fail.
MonadMetadata CompilerDefined in hakyll-4.17.0.0 · Hakyll.Core.Compiler.Internal
Access provided metadata from anywhere
MonadError [String] CompilerDefined in hakyll-4.17.0.0 · Hakyll.Core.Compiler.Internal
Compilation may fail with multiple error messages. catchError handles errors from throwError, fail and noResult

valuegetUnderlying :: Compiler Identifier

Source#

Get the underlying identifier.

valuegetUnderlyingExtension :: Compiler String

Source#

Get the extension of the underlying identifier. Returns something like ".html"

valuemakeItem :: a -> Compiler (Item a)

Source#

Create an item from the underlying identifier and a given value.

valuegetRoute :: Identifier -> Compiler (Maybe FilePath)

Source#

Get the route for a specified item

valuegetResourceBody :: Compiler (Item String)

Source#

Get the full contents of the matched source file as a string, but without metadata preamble, if there was one.

valuegetResourceString :: Compiler (Item String)

Source#

Get the full contents of the matched source file as a string.

valuegetResourceLBS :: Compiler (Item ByteString)

Source#

Get the full contents of the matched source file as a lazy bytestring.

valuegetResourceFilePath :: Compiler FilePath

Source#

Get the file path of the resource we are compiling

typetype Snapshot = String

Source#

Whilst compiling an item, it possible to save multiple snapshots of it, and not just the final result.

valuesaveSnapshot

:: (Binary a, Typeable a)
=> Snapshot
-> Item a
-> Compiler (Item a)

Source#

Save a snapshot of the item. This function returns the same item, which convenient for building >>= chains.

valueload :: (Binary a, Typeable a) => Identifier -> Compiler (Item a)

Source#

Load an item compiled elsewhere. If the required item is not yet compiled, the build system will take care of that automatically.

valueloadSnapshot

:: (Binary a, Typeable a)
=> Identifier
-> Snapshot
-> Compiler (Item a)

Source#

Require a specific snapshot of an item.

valueloadBody :: (Binary a, Typeable a) => Identifier -> Compiler a

Source#

A shortcut for only requiring the body of an item.

loadBody = fmap itemBody . load

valueloadSnapshotBody

:: (Binary a, Typeable a)
=> Identifier
-> Snapshot
-> Compiler a

Source#

A shortcut for only requiring the body for a specific snapshot of an item

valueloadAll :: (Binary a, Typeable a) => Pattern -> Compiler [Item a]

Source#

This function allows you to load a dynamic list of items

valueloadAllSnapshots

:: (Binary a, Typeable a)
=> Pattern
-> Snapshot
-> Compiler [Item a]

Source#

Load a specific snapshot for each of dynamic list of items

valuecached :: (Binary a, Typeable a) => String -> Compiler a -> Compiler a

Source#

Turn on caching for a compilation value to avoid recomputing it on subsequent Hakyll runs. The storage key consists of the underlying identifier of the compiled ressource and the given name.

valuerecompilingUnsafeCompiler :: IO a -> Compiler a

Source#

Run an IO computation in a Compiler. Unlike unsafeCompiler, this function will cause the item to be recompiled every time.

valueunsafeCompiler :: IO a -> Compiler a

Source#

Run an IO computation without dependencies in a Compiler. You probably want recompilingUnsafeCompiler instead.

valuedebugCompiler :: String -> Compiler ()

Source#

Compiler for debugging purposes. Passes a message to the debug logger that is printed in verbose mode.

valuenoResult :: String -> Compiler a

Source#

Fail so that it is treated as non-defined in an $if()$ branching Hakyll.Web.Template macro, and alternative Contexts are tried

valuewithErrorMessage :: String -> Compiler a -> Compiler a

Source#

Prepend an error line to the error, if there is one. This allows you to add helpful context to error messages.