Snap: A Haskell Web Framework (core interfaces and types)
|Version on this page:||0.9.6.4|
|LTS Haskell 19.33:||126.96.36.199@rev:2|
|Stackage Nightly 2023-05-29:||188.8.131.52@rev:1|
|Latest on Hackage:||184.108.40.206@rev:1|
Module documentation for 0.9.6.4
Snap Framework Core
Snap is a web framework for Haskell, based on iteratee I/O (as popularized by
Oleg Kiselyov). For more
information about Snap, read the
README.SNAP.md or visit the Snap project
website at http://www.snapframework.com/.
This is the
snap-core library, which contains:
primitive types and functions for HTTP (requests, responses, cookies, post/query parameters, etc).
type aliases and helper functions for Iteratee I/O.
a “Snap” monad interface, inspired by happstack’s, for programming web handlers, which allows:
stateful access to the HTTP request and response objects.
monadic failure (i.e. MonadPlus/Alternative instances) for declining to handle requests and chaining handlers together.
early termination of the computation if you know early what you want to return and want to prevent further monadic processing.
Some useful utilities for web handlers, including gzip/zlib compression.
The snap-core library is built using Cabal and Hackage. Just run
snap-core toplevel directory.
Building the Haddock Documentation
The haddock documentation can be built using the supplied
The docs get put in
Building the testsuite
Snap is still in its very early stages, so most of the “action” (and a big chunk of the code) right now is centred on the test suite. Snap aims for 100% test coverage, and we’re trying hard to stick to that.
To build the test suite,
cd into the
test/ directory and run
$ cabal configure $ cabal build
From here you can invoke the testsuite by running:
The testsuite generates an
hpc test coverage report in