Yesod.Request

Provides a parsed version of the raw Request data.

Request datatype

type RequestBodyContents = ([(Text, Text)], [(Text, FileInfo)])

A tuple containing both the POST parameters and submitted files.

data Request

The parsed request information.

Constructors

Request

Fields

reqGetParams :: [(Text, Text)]

reqCookies :: [(Text, Text)]

reqWaiRequest :: Request

reqLangs :: [Text]

Languages which the client supports.

reqToken :: Maybe Text

A random, session-specific token used to prevent CSRF attacks.

reqBodySize :: Word64

Size of the request body.

data FileInfo

fileName :: FileInfo -> Text

fileContentType :: FileInfo -> Text

fileSource :: FileInfo -> Source (ResourceT IO) ByteString

fileMove :: FileInfo -> FilePath -> IO ()

Convenience functions

languages :: GHandler s m [Text]

Get the list of supported languages supplied by the user.

Languages are determined based on the following three (in descending order of preference):

• The _LANG get parameter.
• The _LANG cookie.
• The _LANG user session variable.
• Accept-Language HTTP header.

Yesod will seek the first language from the returned list matched with languages supporting by your application. This language will be used to render i18n templates. If a matching language is not found the default language will be used.

This is handled by parseWaiRequest (not exposed).

Lookup parameters

lookupGetParam :: Text -> GHandler s m (Maybe Text)

Lookup for GET parameters.

lookupPostParam :: Text -> GHandler s m (Maybe Text)

lookupCookie :: Text -> GHandler s m (Maybe Text)

Lookup for cookie data.

lookupFile :: Text -> GHandler s m (Maybe FileInfo)

Lookup for POSTed files.

Multi-lookup

lookupGetParams :: Text -> GHandler s m [Text]

Lookup for GET parameters.

lookupPostParams :: Text -> GHandler s m [Text]

Lookup for POST parameters.

lookupCookies :: Text -> GHandler s m [Text]

Lookup for cookie data.

lookupFiles :: Text -> GHandler s m [FileInfo]

Lookup for POSTed files.