Yesod.Content

Content

type Content = ResponseBody

emptyContent :: Content

Zero-length enumerator.

class ToContent a where

Anything which can be converted into Content. Most of the time, you will want to use the ContentEnum constructor. An easier approach will be to use a pre-defined toContent function, such as converting your data into a lazy bytestring and then calling toContent on that.

Methods

toContent :: a -> Content

Instances

ToContent String

ToContent ByteString

ToContent ByteString

ToContent Text

ToContent Text

Mime types

Data type

type ContentType = String

typeHtml :: ContentType

typePlain :: ContentType

typeJson :: ContentType

typeXml :: ContentType

typeAtom :: ContentType

typeJpeg :: ContentType

typePng :: ContentType

typeGif :: ContentType

typeJavascript :: ContentType

typeCss :: ContentType

typeFlv :: ContentType

typeOgv :: ContentType

typeOctet :: ContentType

File extensions

typeByExt :: [(String, ContentType)]

A default extension to mime-type dictionary.

ext :: String -> String

Get a file extension (everything after last period).

Utilities

simpleContentType :: String -> String

Removes "extra" information at the end of a content type string. In particular, removes everything after the semicolon, if present.

For example, "text/html; charset=utf-8" is commonly used to specify the character encoding for HTML data. This function would return "text/html".

Representations

type ChooseRep

Arguments

 = [ContentType]

list of content-types user accepts, ordered by preference

-> IO (ContentType, Content)

A function which gives targetted representations of content based on the content-types the user accepts.

class HasReps a where

Any type which can be converted to representations.

Methods

chooseRep :: a -> ChooseRep

Instances

HasReps ()

HasReps RepXml

HasReps RepPlain

HasReps RepHtmlJson

HasReps RepJson

HasReps RepHtml

HasReps ChooseRep

HasReps RepAtom

HasReps [(ContentType, Content)]

HasReps (ContentType, Content)

defChooseRep :: [(ContentType, a -> IO Content)] -> a -> ChooseRep

A helper method for generating HasReps instances.

This function should be given a list of pairs of content type and conversion functions. If none of the content types match, the first pair is used.

Specific content types

newtype RepHtml

Constructors

RepHtml Content

Instances

HasReps RepHtml

newtype RepJson

Constructors

RepJson Content

Instances

HasReps RepJson

data RepHtmlJson

Constructors

RepHtmlJson Content Content

Instances

HasReps RepHtmlJson

newtype RepPlain

Constructors

RepPlain Content

Instances

HasReps RepPlain

newtype RepXml

Constructors

RepXml Content

Instances

HasReps RepXml

Utilities

formatW3 :: UTCTime -> String

Format a UTCTime in W3 format; useful for setting cookies.

formatRFC1123 :: UTCTime -> String

Format as per RFC 1123.