Copyright	Dennis Gosnell 2017
License	BSD3
Maintainer	Dennis Gosnell (cdep.illabout@gmail.com)
Stability	experimental
Portability	unknown
Safe Haskell	None
Language	Haskell2010

Servant.Static.TH.Internal.Mime

Description

This module exports functions and datatypes for using many different mime types.

Synopsis

data MimeTypeInfo = MimeTypeInfo {
- mimeTypeInfoContentType :: Q Type
- mimeTypeInfoRespType :: Q Type
- mimeTypeInfoToExpression :: ByteString -> Q Exp
}
stringToBs :: String -> ByteString
byteStringToExp :: ByteString -> Q Exp
utf8ByteStringToExp :: ByteString -> Q Exp
htmlToExp :: ByteString -> Q Exp
extensionMimeTypeMap :: Map String MimeTypeInfo
extensionToMimeTypeInfoEx :: FilePath -> Q MimeTypeInfo
extensionToMimeTypeInfo :: FilePath -> Maybe MimeTypeInfo
data CSS
data GIF
data JPEG
data ICO
data JS
data PNG
data SVG
data TXT
data EOT
data TTF
data WOFF
data WOFF2
data JSON
data XML
data GEXF

Documentation

data MimeTypeInfo Source #

Hold Types and functions work working with a given file type, like html or js.

You can find examples of MimeTypeInfo in the function extensionMimeTypeMap.

Constructors

MimeTypeInfo

Fields

mimeTypeInfoContentType :: Q Type
A Q Type representing a type to use for the content type of a Servant API. For instance, HTML files will use something like [t|HTML|], while Javascript files will use something like [t|JS|].
mimeTypeInfoRespType :: Q Type
A Q Type representing the type to use for the return vale of a Servant API. For instance, HTML files will use something like [t|Html|], while JavascriptFiles will use something like [t|ByteString|].
mimeTypeInfoToExpression :: ByteString -> Q Exp
A function that turns a ByteString into an Exp. For an example, look at htmlToExp and byteStringtoExp.

stringToBs :: String -> ByteString Source #

byteStringToExp :: ByteString -> Q Exp Source #

utf8ByteStringToExp :: ByteString -> Q Exp Source #

htmlToExp :: ByteString -> Q Exp Source #

extensionMimeTypeMap :: Map String MimeTypeInfo Source #

A mapping from an extension like html or js to a MimeTypeInfo for that extension.

extensionToMimeTypeInfoEx :: FilePath -> Q MimeTypeInfo Source #

Just like extensionToMimeTypeInfo, but throw an error using fail if the extension for the given FilePath is not found.

extensionToMimeTypeInfo :: FilePath -> Maybe MimeTypeInfo Source #

Lookup the MimeTypeInfo for a given FilePath (that has an extension like .html or .js). Returns Nothing if the MimeTypeInfo for the given extension is not found.

data CSS Source #

Instances

Accept CSS Source #	text/css
Instance details Defined in Servant.Static.TH.Internal.Mime Methods contentType :: Proxy CSS -> MediaType # contentTypes :: Proxy CSS -> NonEmpty MediaType #
MimeRender CSS ByteString Source #
Instance details Defined in Servant.Static.TH.Internal.Mime Methods mimeRender :: Proxy CSS -> ByteString -> ByteString0 #

data GIF Source #

Instances

Accept GIF Source #	image/gif
Instance details Defined in Servant.Static.TH.Internal.Mime Methods contentType :: Proxy GIF -> MediaType # contentTypes :: Proxy GIF -> NonEmpty MediaType #
MimeRender GIF ByteString Source #
Instance details Defined in Servant.Static.TH.Internal.Mime Methods mimeRender :: Proxy GIF -> ByteString -> ByteString0 #

data JPEG Source #

Instances

Accept JPEG Source #	image/jpeg
Instance details Defined in Servant.Static.TH.Internal.Mime Methods contentType :: Proxy JPEG -> MediaType # contentTypes :: Proxy JPEG -> NonEmpty MediaType #
MimeRender JPEG ByteString Source #
Instance details Defined in Servant.Static.TH.Internal.Mime Methods mimeRender :: Proxy JPEG -> ByteString -> ByteString0 #

data ICO Source #

Since: 0.2.0.0

Instances

Accept ICO Source #	icon/ico
Instance details Defined in Servant.Static.TH.Internal.Mime Methods contentType :: Proxy ICO -> MediaType # contentTypes :: Proxy ICO -> NonEmpty MediaType #
MimeRender ICO ByteString Source #
Instance details Defined in Servant.Static.TH.Internal.Mime Methods mimeRender :: Proxy ICO -> ByteString -> ByteString0 #

data JS Source #

Instances

Accept JS Source #	application/javascript
Instance details Defined in Servant.Static.TH.Internal.Mime Methods contentType :: Proxy JS -> MediaType # contentTypes :: Proxy JS -> NonEmpty MediaType #
MimeRender JS ByteString Source #
Instance details Defined in Servant.Static.TH.Internal.Mime Methods mimeRender :: Proxy JS -> ByteString -> ByteString0 #

data PNG Source #

Instances

Accept PNG Source #	image/png
Instance details Defined in Servant.Static.TH.Internal.Mime Methods contentType :: Proxy PNG -> MediaType # contentTypes :: Proxy PNG -> NonEmpty MediaType #
MimeRender PNG ByteString Source #
Instance details Defined in Servant.Static.TH.Internal.Mime Methods mimeRender :: Proxy PNG -> ByteString -> ByteString0 #

data SVG Source #

Instances

Accept SVG Source #	image/svg
Instance details Defined in Servant.Static.TH.Internal.Mime Methods contentType :: Proxy SVG -> MediaType # contentTypes :: Proxy SVG -> NonEmpty MediaType #
MimeRender SVG ByteString Source #
Instance details Defined in Servant.Static.TH.Internal.Mime Methods mimeRender :: Proxy SVG -> ByteString -> ByteString0 #

data TXT Source #

Instances

Accept TXT Source #	text/plain
Instance details Defined in Servant.Static.TH.Internal.Mime Methods contentType :: Proxy TXT -> MediaType # contentTypes :: Proxy TXT -> NonEmpty MediaType #
MimeRender TXT ByteString Source #
Instance details Defined in Servant.Static.TH.Internal.Mime Methods mimeRender :: Proxy TXT -> ByteString -> ByteString0 #

data EOT Source #

Since: 0.2.0.0

Instances

Accept EOT Source #	fonts/eot
Instance details Defined in Servant.Static.TH.Internal.Mime Methods contentType :: Proxy EOT -> MediaType # contentTypes :: Proxy EOT -> NonEmpty MediaType #
MimeRender EOT ByteString Source #
Instance details Defined in Servant.Static.TH.Internal.Mime Methods mimeRender :: Proxy EOT -> ByteString -> ByteString0 #

data TTF Source #

Since: 0.2.0.0

Instances

Accept TTF Source #	fonts/ttf
Instance details Defined in Servant.Static.TH.Internal.Mime Methods contentType :: Proxy TTF -> MediaType # contentTypes :: Proxy TTF -> NonEmpty MediaType #
MimeRender TTF ByteString Source #
Instance details Defined in Servant.Static.TH.Internal.Mime Methods mimeRender :: Proxy TTF -> ByteString -> ByteString0 #

data WOFF Source #

Since: 0.2.0.0

Instances

Accept WOFF Source #	fonts/woff
Instance details Defined in Servant.Static.TH.Internal.Mime Methods contentType :: Proxy WOFF -> MediaType # contentTypes :: Proxy WOFF -> NonEmpty MediaType #
MimeRender WOFF ByteString Source #
Instance details Defined in Servant.Static.TH.Internal.Mime Methods mimeRender :: Proxy WOFF -> ByteString -> ByteString0 #

data WOFF2 Source #

Since: 0.2.0.0

Instances

Accept WOFF2 Source #	fonts/woff2
Instance details Defined in Servant.Static.TH.Internal.Mime Methods contentType :: Proxy WOFF2 -> MediaType # contentTypes :: Proxy WOFF2 -> NonEmpty MediaType #
MimeRender WOFF2 ByteString Source #
Instance details Defined in Servant.Static.TH.Internal.Mime Methods mimeRender :: Proxy WOFF2 -> ByteString -> ByteString0 #

data JSON Source #

JSON file

Instances

Accept JSON Source #	application/json
Instance details Defined in Servant.Static.TH.Internal.Mime Methods contentType :: Proxy JSON -> MediaType # contentTypes :: Proxy JSON -> NonEmpty MediaType #
MimeRender JSON ByteString Source #
Instance details Defined in Servant.Static.TH.Internal.Mime Methods mimeRender :: Proxy JSON -> ByteString -> ByteString0 #

data XML Source #

XML file

Instances

Accept XML Source #	application/xml
Instance details Defined in Servant.Static.TH.Internal.Mime Methods contentType :: Proxy XML -> MediaType # contentTypes :: Proxy XML -> NonEmpty MediaType #
MimeRender XML ByteString Source #
Instance details Defined in Servant.Static.TH.Internal.Mime Methods mimeRender :: Proxy XML -> ByteString -> ByteString0 #

data GEXF Source #

GEXF file (xml for graph application)

Instances

Accept GEXF Source #	application/gexf
Instance details Defined in Servant.Static.TH.Internal.Mime Methods contentType :: Proxy GEXF -> MediaType # contentTypes :: Proxy GEXF -> NonEmpty MediaType #
MimeRender GEXF ByteString Source #
Instance details Defined in Servant.Static.TH.Internal.Mime Methods mimeRender :: Proxy GEXF -> ByteString -> ByteString0 #