Yesod.Core.Dispatch

A quasi-quoter to parse a string into a list of Resources. Checks for overlapping routes, failing if present; use parseRoutesNoCheck to skip the checking. See documentation site for details on syntax.

Same as parseRoutes, but performs no overlap checking.

Same as parseRoutes, but uses an external file instead of quasiquotation.

The recommended file extension is .yesodroutes.

Same as parseRoutesNoCheck, but uses an external file instead of quasiquotation.

The recommended file extension is .yesodroutes.

Generates URL datatype and site function for the given Resources. This is used for creating sites, not subsites. See mkYesodSubData and mkYesodSubDispatch for the latter. Use parseRoutes to create the Resources.

Contexts and type variables in the name of the datatype are parsed. For example, a datatype App a with typeclass constraint MyClass a can be written as "(MyClass a) => App a".

mkYesod but with custom options.

Similar to mkYesod, except contexts and type variables are not parsed. Instead, they are explicitly provided. You can write (MyClass a) => App a with mkYesodWith [["MyClass","a"]] "App" ["a"] ....

Same as toWaiAppPlain, but provides a default set of middlewares. This set may change with future releases, but currently covers:

• Logging

• GZIP compression

• Automatic HEAD method handling

• Request method override with the _method query string parameter

• Accept header override with the _accept query string parameter

Convert the given argument into a WAI application, executable with any WAI handler. This function will provide no middlewares; if you want commonly used middlewares, please use toWaiApp.

Pure low level function to construct WAI application. Usefull when you need not standard way to run your app, or want to embed it inside another app.

A convenience method to run an application using the Warp webserver on the specified port. Automatically calls toWaiApp. Provides a default set of middlewares. This set may change at any point without a breaking version number. Currently, it includes:

• Logging

• GZIP compression

• Automatic HEAD method handling

• Request method override with the _method query string parameter

• Accept header override with the _accept query string parameter

If you need more fine-grained control of middlewares, please use toWaiApp directly.

Since 1.2.0

Deprecated synonym for warp.

Runs your application using default middlewares (i.e., via toWaiApp). It reads port information from the PORT environment variable, as used by tools such as Keter and the FP Complete School of Haskell.

Note that the exact behavior of this function may be modified slightly over time to work correctly with external tools, without a change to the type signature.

A default set of middlewares.

Since 1.2.0

All of the default middlewares, excluding logging.

Since 1.2.12

Wrap up a normal WAI application as a Yesod subsite. Ignore parent site's middleware and isAuthorized.

Like WaiSubsite, but applies parent site's middleware and isAuthorized.