h&#      !"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\]^_`abcdefghijklmnopqrstuvwxyz{|}~                                            Safe-Inferred"%&6^ Safe-Inferred"%&6snapAppConfig contains the config options for command line arguments in snaplet-based apps.snap.Command line options for snaplet applications.snapCalls snap-server's extendedCommandLineConfig to add snaplet options to the built-in server command line options. Safe-Inferred"%&6+  Safe-Inferred"%&6 Safe-Inferred"%&6  Safe-Inferred"%&6",snapAn opaque data type holding internal snaplet configuration data. It is exported publicly because the getOpaqueConfig function in MonadSnaplet makes implementing new instances of MonadSnaplet more convenient.snapHolds the actual route pattern passed to addRoutes for the current handler. Nothing during initialization and before route dispatech.snapThis is the universal reload action for the top-level site. We can't update this in place to be a reloader for each individual snaplet because individual snaplets can't be reloaded in isolation without losing effects that subsequent hooks may have had.snapSnaplet's type parameter s here is user-defined and can be any Haskell type. A value of type  Snaplet s countains a couple of things:a value of type s, called the "user state".some bookkeeping data the framework uses to plug things together, like the snaplet's configuration, the snaplet's root directory on the filesystem, the snaplet's root URL, and so on.snapSee the _reloader comment for why we have to use this to reload single snaplets in isolation. This action won't actually run the initializer at all. It will only modify the existing state. It is the responsibility of the snaplet author to avoid using this in situations where it will destroy data in its state that was created by subsequent hook actions.snap1Joins a reversed list of directories into a path.snap1Joins a reversed list of directories into a path. snap%Monad used for initializing snaplets.snapWrapper around IO actions that modify state elements created during initialization. snapInformation about a partially constructed initializer. Used to automatically aggregate handlers and cleanup actions.snap,Handler routes built up and passed to route.snapGeneric filtering of handlerssnapThis snaplet config is the incrementally built config for whatever snaplet is currently being constructed.snapWe can't just hae a simple MVar here because MVars can't be chrooted. snapSnaplet infrastructure is available during runtime request processing through the Handler monad. There aren't very many standalone functions to read about here, but this is deceptive. The key is in the type class instances. Handler is an instance of , which means it is the monad you will use to write all your application routes. It also has a   instance, which gives you all the functionality described above. snapThe m type parameter used in the MonadSnaplet type signatures will usually be either Initializer or Handler, but other monads may sometimes be useful.Minimal complete definition:, , , and . snapRuns a child snaplet action in the current snaplet's context. If you think about snaplet lenses using a filesystem path metaphor, the lens supplied to this snaplet must be a relative path. In other words, the lens's base state must be the same as the current snaplet.snapLike   but doesn't impose the requirement that the action being run be a descendant of the current snaplet. Using our filesystem metaphor again, the lens for this function must be an absolute path--it's base must be the same as the current base.snap A variant of   accepting a lens from snaplet to snaplet. Unlike the lens used in the above   function, this lens formulation has an identity, which makes it useful in certain circumstances. The lenses generated by  will not work with this function, however the lens returned by  will. with = with' . subSnapletsnapThe absolute version of snap&Gets the lens for the current snaplet.snapGets the current snaplet's opaque config data type. You'll only use this function when writing MonadSnaplet instances.snapTransforms a lens of the type you get from makeLenses to an similar lens that is more suitable for internal use.snapGets a list of the names of snaplets that are direct ancestors of the current snaplet.snap*Gets the snaplet's path on the filesystem.snapGets the current snaple's name.snap1Gets a human readable description of the snaplet.snap7Gets the config data structure for the current snaplet.snapGets the base URL for the current snaplet. Directories get added to the current snaplet path by calls to  nestSnaplet.snap1Constructs a url relative to the current snaplet.snap Gets the  Snaplet v" from the current snaplet's state.snap Puts a new  Snaplet v in the current snaplet's state. snap Modifies the  Snaplet v in the current snaplet's state.!snap Gets the  Snaplet v from the current snaplet's state and applies a function to it.snapLike runBase0, but it doesn't require an MVar to be executed."snapGets the route pattern that matched for the handler. This lets you find out exactly which of the strings you used in addRoutes matched.#snapSets the route pattern that matched for the handler. Use this when to override the default pattern which is the key to the alist passed to addRoutes.snap/Check whether the request comes from localhost.$snap1Pass if the request is not coming from localhost.%snapHandler that reloads the site.&snapThis function brackets a Handler action in resource acquisition and release. Like ,, this is provided because MonadCatchIO's bracket function doesn't work properly in the case of a short-circuit return from the action being bracketed.In order to prevent confusion regarding the effects of the aquisition and release actions on the Handler state, this function doesn't accept Handler actions for the acquire or release actions.This function will run the release action in all cases where the acquire action succeeded. This includes the following behaviors from the bracketed Snap action. Normal completion.Short-circuit completion, either from calling  or  finishWithAn exception being thrown.snap8Lets you access the current snaplet's state through the  interface.snap8Lets you access the current snaplet's state through the  interface.'snapOpaque newtype which gives us compile-time guarantees that the user is using makeSnaplet and either nestSnaplet or embedSnaplet correctly. snap%A relative lens identifying a snapletsnapAction from the lense's snapletsnap(An "absolute" lens identifying a snapletsnapAction from the lense's snaplet      !"#$%&' Safe-Inferred"%&6Fe$snap for InitializerState.snap for InitializerState.snapgets for InitializerState.(snapLets you retrieve the list of routes currently set up by an Initializer. This can be useful in debugging.)snapReturn the current environment string. This will be the environment given to 5& or from the command line when using 7. Useful for changing behavior during development and testing.snap*Converts a plain hook into a Snaplet hook.*snapAdds an IO action that modifies the current snaplet state to be run at the end of initialization on the state that was created. This makes it easier to allow one snaplet's state to be modified by another snaplet's initializer. A good example of this is when a snaplet has templates that define its views. The Heist snaplet provides the  addTemplates function which allows other snaplets to set up their own templates.  addTemplates% is implemented using this function.+snapVariant of addPostInitHook for when you have things wrapped in a Snaplet.snap'Helper function for transforming hooks.snap'Helper function for transforming hooks.snap)Modifies the Initializer's SnapletConfig.snapIf a snaplet has a filesystem presence, this function creates and copies the files if they dont' already exist.,snap6All snaplet initializers must be wrapped in a call to  makeSnaplet, which handles standardized housekeeping common to all snaplets. Common usage will look something like this: fooInit :: SnapletInit b Foo fooInit = makeSnaplet "foo" "An example snaplet" Nothing $ do -- Your initializer code here return $ Foo 42 Note that you're writing your initializer code in the Initializer monad, and makeSnaplet converts it into an opaque SnapletInit type. This allows us to use the type system to ensure that the API is used correctly.snapInternal function that gets the SnapletConfig out of the initializer state and uses it to create a (Snaplet a).snapBrackets an initializer computation, restoring curConfig after the computation returns.snapHandles modifications to InitializerState that need to happen before a snaplet is called with either nestSnaplet or embedSnaplet.-snapRuns another snaplet's initializer and returns the initialized Snaplet value. Calling an initializer with nestSnaplet gives the nested snaplet access to the same base state that the current snaplet has. This makes it possible for the child snaplet to make use of functionality provided by sibling snaplets..snapRuns another snaplet's initializer and returns the initialized Snaplet value. The difference between this and - is the first type parameter in the third argument. The "v1 v1" makes the child snaplet think that it is the top-level state, which means that it will not be able to use functionality provided by snaplets included above it in the snaplet tree. This strongly isolates the child snaplet, and allows you to eliminate the b type variable. The embedded snaplet can still get functionality from other snaplets, but only if it nests or embeds the snaplet itself.Note that this function does not change where this snaplet is located in the filesystem. The snaplet directory structure convention stays the same. Also, embedSnaplet limits the ways that snaplets can interact, so we usually recommend using nestSnaplet instead. However, we provide this function because sometimes reduced flexibility is useful. In short, if you don't understand what this function does for you from looking at its type, you probably don't want to use it.snap)Changes the base state of an initializer.snap$Changes the base state of a handler./snapSets a snaplet's name. All snaplets have a default name set by the snaplet author. This function allows you to override that name. You will have to do this if you have more than one instance of the same kind of snaplet because snaplet names must be unique. This function must immediately surround the snaplet's initializer. For example: >fooState <- nestSnaplet "fooA" $ nameSnaplet "myFoo" $ fooInit0snapAdds routing to the current  . The new routes are merged with the main routing section and take precedence over existing routing that was previously defined.1snap Wraps the base snaplet's routing in another handler, allowing you to run code before and after all routes in an application..Here are some examples of things you might do: wrapSite (\site -> logHandlerStart >> site >> logHandlerFinished) wrapSite (\site -> ensureAdminUser >> site)2snapAttaches an unload handler to the snaplet. The unload handler will be called when the server shuts down, or is reloaded.snap3snapInitializers should use this function for all informational or error messages to be displayed to the user. On application startup they will be sent to the console. When executed from the reloader, they will be sent back to the user in the HTTP response.snap;Builds an IO reload action for storage in the SnapletState.snap+Runs a top-level snaplet in the Snap monad.4snapLets you change a snaplet's initial state. It's almost like a reload, except that it doesn't run the initializer. It just modifies the result of the initializer. This can be used to let you define actions for reloading individual snaplets.snapInternal function for running Initializers. If any exceptions were thrown by the initializer, this function catches them, runs any cleanup actions that had been registered, and returns an expanded error message containing the exception details as well as all messages generated by the initializer before the exception was thrown.5snapGiven an environment and a Snaplet initializer, produce a concatenated log of all messages generated during initialization, a snap handler, and a cleanup action. The environment is an arbitrary string such as "devel" or "production". This string is used to determine the name of the configuration files used by each snaplet. If an environment of Nothing is used, then runSnaplet defaults to "devel".6snapGiven a configuration and a snap handler, complete it and produce the completed configuration as well as a new toplevel handler with things like compression and a 500 handler set up.7snapInitialize and run a Snaplet. This function parses command-line arguments, runs the given Snaplet initializer, and starts an HTTP server running the Snaplet's toplevel  .8snapLike 70, but don't try to parse command-line arguments.9snapAllows you to get all of your app's config data in the IO monad without the web server infrastructure.snap#Recursive worker for loadAppConfig. snapThe directory where the snaplet's reference files are stored. Nothing if the snaplet doesn't come with any files that need to be installed.snap+Directory where the files should be copied.,snapA default id for this snaplet. This is only used when the end-user has not already set an id using the nameSnaplet function.snap-A human readable description of this snaplet.snapThe path to the directory holding the snaplet's reference filesystem content. This will almost always be the directory returned by Cabal's getDataDir command, but it has to be passed in because it is defined in a package-specific import. Setting this value to Nothing doesn't preclude the snaplet from having files in in the filesystem, it just means that they won't be copied there automatically.snapSnaplet initializer.-snapThe root url for all the snaplet's routes. An empty string gives the routes the same root as the parent snaplet's routes.snapLens identifying the snapletsnap,The initializer function for the subsnaplet..snapThe root url for all the snaplet's routes. An empty string gives the routes the same root as the parent snaplet's routes.NOTE: Because of the stronger isolation provided by embedSnaplet, you should be more careful about using an empty string here.snapLens identifying the snapletsnap,The initializer function for the subsnaplet./snapThe snaplet namesnap The snaplet initializer function1snapHandler modifier function7snapThe configuration of the server - you can usually pass a default  via .snap!The snaplet initializer function.8snapThe configuration of the server - you can usually pass a default  via .snap!The snaplet initializer function.9snapThe name of the config file to look for. In snap applications, this is something based on the environment...i.e.  devel.cfg.snap+Path to the root directory of your project.()*+,-./0123456789 Safe-Inferred"%&6F2  !"#$%&'()*+,-./01234567892 "# ! ',-./2*+3()01 $%4&56789 Safe-Inferred"%&6K_:snapThe state for the Heist snaplet. To use the Heist snaplet in your app include this in your application state and use  heistInit to initialize it. The type parameter b will typically be the base state type for your application.snapGeneric initializer function that allows compiled/interpreted template serving to be specified by the caller.snapInternal worker function used by variants of heistInit. This is necessary because of the divide between SnapletInit and Initializer.snapHook that converts the Heist type from Configuring to Running at the end of initialization.>snapHandler that triggers a template reload. For large sites, this can be desireable because it may be much quicker than the full site reload provided at the adminreload route. This allows you to reload only the heist templates This handler is automatically set up by heistInit, but if you use heistInit', then you can create your own route with it.:;=<> Safe-Inferred"%&6XBsnapClears data stored by the cache tag. The cache tag automatically reloads its data when the specified TTL expires, but sometimes you may want to trigger a manual reload. This function lets you do that.CsnapThe   for :1. This function is a convenience wrapper around C` that uses defaultHeistState and sets up routes for all the templates. It sets up a "heistReload" route that reloads the heist templates when you request it from localhost.DsnapA lower level   for :. This initializer requires you to specify the initial HeistConfig. It also does not add any routes for templates, allowing you complete control over which templates get routed.EsnapSets the snaplet to default to interpreted mode. Initially, the initializer sets the value to compiled mode. This function allows you to override that setting. Note that this is just a default. It only has an effect if you use one of the generic functions: X, Y, Z, or [. If you call the non-generic versions directly, then this value will not be checked and you will get the mode implemented by the function you called.FsnapAdds templates to the Heist HeistConfig. Other snaplets should use this function to add their own templates. The templates are automatically read from the templates directory in the current snaplet's filesystem root.GsnapAdds templates to the Heist HeistConfig, and lets you specify where they are found in the filesystem. Note that the path to the template directory is an absolute path. This allows you more flexibility in where your templates are located, but means that you have to explicitly call getSnapletFilePath if you want your snaplet to use templates within its normal directory structure.NsnapAdds more HeistConfig data using mappend with whatever is currently there. This is the preferred method for adding all four kinds of splices as well as new templates.snap'Internal helper function for rendering.snap'Internal helper function for rendering.WsnapChooses between a compiled action and an interpreted action based on the configured default.XsnapLike render/cRender, but chooses between the two appropriately based on the default mode.YsnapLike renderAs/cRenderAs, but chooses between the two appropriately based on the default mode.ZsnapLike heistServe/cHeistServe, but chooses between the two appropriately based on the default mode.[snapLike heistServeSingle/cHeistServeSingle, but chooses between the two appropriately based on the default mode.bsnapThis instance is here because we don't want the heist package to depend on anything from snap packages. CsnapPath to templatesDsnapPath to templatessnapInitial HeistConfigFsnap&The url prefix for the template routesGsnapURL prefix for template routessnapPath to templatesOsnapName of the templatePsnap Content typesnapName of the templateSsnapName of the templateTsnap Content typesnapName of the templateWsnapA compiled actionsnapAn interpreted actionXsnapName of the templateYsnap Content typesnapName of the template(:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\]^_`a(:;<=CD>EHBFGIKJMLXYZ[WNSTUVOPQR]_a\^`A?@ Safe-Inferred"%&6jcsnapA single snaplet should never need more than one instance of Heist as a subsnaplet. This type class allows you to make it easy for other snaplets to get the lens that identifies the heist snaplet. Here's an example of how the heist snaplet might be declared: data App = App { _heist :: Snaplet (Heist App) } makeLenses ''App instance HasHeist App where heistLens = subSnaplet heist appInit = makeSnaplet "app" "" Nothing $ do h <- nestSnaplet "heist" heist $ heistInit "templates" addConfig h heistConfigWithMyAppSplices return $ App hdsnapA lens to the Heist snaplet. The b parameter to Heist will typically be the base state of your application.esnapAdds templates to the Heist HeistState. Other snaplets should use this function to add their own templates. The templates are automatically read from the templates directory in the current snaplet's filesystem root.fsnapAdds templates to the Heist HeistState, and lets you specify where they are found in the filesystem. Note that the path to the template directory is an absolute path. This allows you more flexibility in where your templates are located, but means that you have to explicitly call getSnapletFilePath if you want your snaplet to use templates within its normal directory structure.gsnapMore general function allowing arbitrary HeistState modification.hsnapMore general function allowing arbitrary HeistState modification.isnap,Runs a function on with the Heist snaplet's .jsnapGeneric version of s/o.ksnapGeneric version of t/p.lsnapGeneric version of u/q.msnapGeneric version of v/r.nsnapChooses between a compiled action and an interpreted action based on the configured default.osnapRenders a compiled template as text/html. If the given template is not found, this returns empty.psnapRenders a compiled template as the given content type. If the given template is not found, this returns empty.qsnapA compiled version of u.rsnap Analogous to fileServeSingle<. If the given template is not found, this throws an error.ssnapRenders a template as text/html. If the given template is not found, this returns empty.tsnapRenders a template as the given content type. If the given template is not found, this returns empty.usnap4A handler that serves all the templates (similar to serveDirectory). If the template specified in the request path is not found, it returns empty. Also, this function does not serve any templates beginning with an underscore. This gives you a way to prevent some templates from being served. For example, you might have a template that contains only the navbar of your pages, and you probably wouldn't want that template to be visible to the user as a standalone template. So if you put it in a file called "_nav.tpl", this function won't serve it.vsnap2Handler for serving a single template (similar to fileServeSingle=). If the given template is not found, this throws an error.wsnapRenders a template with a given set of splices. This is syntax sugar for a common combination of heistLocal, bindSplices, and render.xsnap=Runs an action with additional splices bound into the Heist .ysnapRuns a handler with a modified . You might want to use this if you had a set of splices which were customised for a specific action. To do that you would do: :heistLocal (bindSplices mySplices) handlerThatNeedsSplicesesnap&The url prefix for the template routesfsnapURL prefix for template routessnapPath to templateshsnapHeistState modifying functionisnapHeistState function to runjsnap Template nameksnapContent type to render withsnap Template namemsnap Template namensnapA compiled actionsnapAn interpreted actionosnap Template namepsnapContent type to render withsnap Template namersnap Template namessnap Template nametsnapContent type to render withsnap Template namevsnap Template namewsnap Template namesnapSplices to bindxsnapSplices to bindsnapHandler to runysnapHeistState modifying functionsnapHandler to run":>?@ABCDEHNcdefghijklmnopqrstuvwxy":cdCD>EHefNghijklmnopqrstuvyxwA@?B Safe-Inferred"%&6k/:?ABCDNcdefghistuvwxy:cdA?CDefNghistuvyxwB Safe-Inferred"%&6k:@ABNcdefghijklmn:cdA@efNghijklmnB Safe-Inferred"%&6qzsnapThe   for :1. This function is a convenience wrapper around z` that uses defaultHeistState and sets up routes for all the templates. It sets up a "heistReload" route that reloads the heist templates when you request it from localhost.{snapRenders a compiled template as text/html. If the given template is not found, this returns empty.|snapRenders a compiled template as the given content type. If the given template is not found, this returns empty.}snap4A handler that serves all the templates (similar to serveDirectory). If the template specified in the request path is not found, it returns empty. Also, this function does not serve any templates beginning with an underscore. This gives you a way to prevent some templates from being served. For example, you might have a template that contains only the navbar of your pages, and you probably wouldn't want that template to be visible to the user as a standalone template. So if you put it in a file called "_nav.tpl", this function won't serve it.~snap2Handler for serving a single template (similar to fileServeSingle=). If the given template is not found, this throws an error.zsnapPath to templates{snap Template name|snapContent type to render withsnap Template name~snap Template name:>@ABDNcdefghiz{|}~:cdA@zD>efNghi{|}~B Safe-Inferred"%&56{snap6Authentication settings defined at initialization timesnapCurrently not used/checkedsnap#Name of the desired remember cookiesnapHow long to remember when the option is used in rest of the API. % means remember until end of session.snap4Lockout strategy: ([MaxAttempts], [LockoutDuration])snap Location of app's encryption keysnap