Safe Haskell	None
Language	Haskell98

Data.FileEmbed

Contents

Embed at compile time
Inject into an executable
Internal

Description

This module uses template Haskell. Following is a simplified explanation of usage for those unfamiliar with calling Template Haskell functions.

The function embedFile in this modules embeds a file into the exceutable that you can use it at runtime. A file is represented as a ByteString. However, as you can see below, the type signature indicates a value of type Q Exp will be returned. In order to convert this into a ByteString, you must use Template Haskell syntax, e.g.:

$(embedFile "myfile.txt")

This expression will have type ByteString. Be certain to enable the TemplateHaskell language extension, usually by adding the following to the top of your module:

{-# LANGUAGE TemplateHaskell #-}

Synopsis

Embed at compile time

embedFile :: FilePath -> Q Exp Source

Embed a single file in your source code.

import qualified Data.ByteString

myFile :: Data.ByteString.ByteString
myFile = $(embedFile "dirName/fileName")

embedOneFileOf :: [FilePath] -> Q Exp Source

Embed a single existing file in your source code out of list a list of paths supplied.

import qualified Data.ByteString

myFile :: Data.ByteString.ByteString
myFile = $(embedFile' [ "dirName/fileName", "src/dirName/fileName" ])

embedDir :: FilePath -> Q Exp Source

Embed a directory recursively in your source code.

import qualified Data.ByteString

myDir :: [(FilePath, Data.ByteString.ByteString)]
myDir = $(embedDir "dirName")

getDir :: FilePath -> IO [(FilePath, ByteString)] Source

Get a directory tree in the IO monad.

This is the workhorse of embedDir

Inject into an executable

dummySpace :: Int -> Q Exp Source

dummySpaceWith :: ByteString -> Int -> Q Exp Source

Like dummySpace, but takes a postfix for the magic string. In order for this to work, the same postfix must be used by inject / injectFile. This allows an executable to have multiple ByteStrings injected into it, without encountering collisions.

Since 0.0.8

inject Source

Arguments

:: ByteString	bs to inject
-> ByteString	original BS containing dummy
-> Maybe ByteString	new BS, or Nothing if there is insufficient dummy space

injectFile Source

Arguments

:: ByteString	bs to inject
-> FilePath	template file
-> FilePath	output file
-> IO ()

injectWith Source

Arguments

:: ByteString	postfix of magic string
-> ByteString	bs to inject
-> ByteString	original BS containing dummy
-> Maybe ByteString	new BS, or Nothing if there is insufficient dummy space

Like inject, but takes a postfix for the magic string.

Since 0.0.8

injectFileWith Source

Arguments

:: ByteString	postfix of magic string
-> ByteString	bs to inject
-> FilePath	template file
-> FilePath	output file
-> IO ()

Like injectFile, but takes a postfix for the magic string.

Since 0.0.8

Internal

stringToBs :: String -> ByteString Source

bsToExp :: ByteString -> Q Exp Source