Skip to content
Core type definitions (Snap monad, HTTP types, etc) and utilities for web handlers.
Haskell CSS Other
Latest commit b5ca1f0 @gregorycollins gregorycollins Merge branch '0.9-stable'
Conflicts:
	snap-core.cabal
	src/Snap/Internal/Http/Types.hs
	src/Snap/Internal/Parsing.hs
	src/Snap/Internal/Types.hs
Failed to load latest commit information.
cbits
extra Twiddle file-upload docs
src/Snap
test
.gitignore bumped package upper bounds
.stylish-haskell.yaml Minimize imports for snap-core.
CONTRIBUTORS Copypasta FastSet from the attoparsec source (bos just made it private)
LICENSE Google asserts copyright, even on work I do in my own time.
README.SNAP.md
README.md
Setup.hs Add Setup.hs
TODO Change content-length and enumerator lengths from Int to Int64
changelog.md add changelog
haddock.sh Remove extra css
runTestsAndCoverage.sh Remove mentions of iteratees
snap-core.cabal Bump the dependency on 'vector'.
style-guide.md

README.md

Snap Framework Core

Snap is a web framework for Haskell. For more information about Snap, read the README.SNAP.md or visit the Snap project website at http://www.snapframework.com/.

Library contents

This is the snap-core library, which contains:

  • primitive types and functions for HTTP (requests, responses, cookies, post/query parameters, etc).

  • a "Snap" monad interface 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.

  • useful utilities for web handlers, like file serving and gzip/zlib compression.

Building snap-core

The snap-core library is built using Cabal and Hackage. Just run

cabal install

from the snap-core toplevel directory.

Building the Haddock Documentation

The haddock documentation can be built using the supplied haddock.sh shell script:

./haddock.sh

The docs get put in dist/doc/html/.

Building the testsuite

Snap aims for 100% test coverage, and we're trying hard to stick to that.

To build the test suite, configure with --enable-tests:

$ cabal configure --enable-tests
$ cabal build

From here you can invoke the testsuite by running:

$ ./runTestsAndCoverage.sh

The testsuite generates an hpc test coverage report in dist/hpc.

Something went wrong with that request. Please try again.