Hackage :: [Package]

snap-core: Snap: A Haskell Web Framework (Core)

[ bsd3, io-streams, library, snap, web ] [ Propose Tags ] [ Report a vulnerability ]

This is the first developer prerelease of the Snap framework. Snap is a simple and fast web development framework and server written in Haskell. For more information or to download the latest version, you can visit the Snap project website at http://snapframework.com/.

This library contains the core definitions and types for the Snap framework, including:

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

  2. Type aliases and helper functions for Iteratee I/O

  3. A monad for programming web handlers called "Snap", inspired by happstack's (http://happstack.com/index.html), 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

Quick start: The Snap monad and HTTP definitions are in Snap.Types, some iteratee utilities are in Snap.Iteratee.

Higher-level facilities for building web applications (like user/session management, component interfaces, data modeling, etc.) are planned but not yet implemented, so this release will mostly be of interest for those who:

  • need a fast and minimal HTTP API at roughly the same level of abstraction as Java servlets, or

  • are interested in contributing to the Snap Framework project.

[Skip to Readme]

Flags

Automatic Flags
NameDescriptionDefault
portable

Compile in cross-platform mode. No platform-specific code or optimizations such as C routines will be used.

Disabled
no-debug

Disable any debug logging code. Without this flag, Snap will test the DEBUG environment variable to decide whether to do logging, and this introduces a tiny amount of overhead (a call into a function pointer) because the calls to debug cannot be inlined. Users who want to squeeze out maximum performance can set the no-debug flag to get a version of Snap which has debug calls that should be inlined away.

Disabled

Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info

Downloads

Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees

Candidates

  • No Candidates
Versions [RSS] 0.1.1, 0.1.2, 0.2.1, 0.2.2, 0.2.3, 0.2.4, 0.2.5, 0.2.6, 0.2.7, 0.2.7.1, 0.2.8, 0.2.8.1, 0.2.9, 0.2.10, 0.2.11, 0.2.12, 0.2.13, 0.2.14, 0.2.15, 0.2.15.1, 0.2.16, 0.3.0, 0.3.1, 0.3.1.1, 0.4.0, 0.4.0.1, 0.4.0.2, 0.4.1, 0.4.2, 0.4.3, 0.5.0, 0.5.1, 0.5.1.1, 0.5.1.2, 0.5.1.3, 0.5.1.4, 0.5.2, 0.5.3, 0.5.3.1, 0.5.4, 0.5.5, 0.6.0, 0.6.0.1, 0.7, 0.7.0.1, 0.8.0, 0.8.0.1, 0.8.1, 0.9.0, 0.9.2, 0.9.2.1, 0.9.2.2, 0.9.3, 0.9.3.1, 0.9.4.0, 0.9.4.1, 0.9.5.0, 0.9.6.0, 0.9.6.1, 0.9.6.2, 0.9.6.3, 0.9.6.4, 0.9.7.0, 0.9.7.2, 0.9.8.0, 1.0.0.0, 1.0.1.0, 1.0.1.1, 1.0.2.0, 1.0.2.1, 1.0.3.0, 1.0.3.1, 1.0.3.2, 1.0.4.0, 1.0.4.1, 1.0.4.2, 1.0.5.0, 1.0.5.1
Dependencies attoparsec (>=0.8.1 && <0.9), base (>=4 && <5), bytestring, bytestring-mmap (>=0.2.1 && <0.3), bytestring-nums, bytestring-show (>=0.3.2 && <0.4), cereal (>=0.3 && <0.4), containers, deepseq (>=1.1 && <1.2), directory, directory-tree, dlist (>=0.5 && <0.6), filepath, haskell98, iteratee (>=0.3.1 && <0.4), ListLike (>=1 && <2), MonadCatchIO-transformers (>=0.2.1 && <0.3), monads-fd, old-locale, old-time, template-haskell, text (>=0.10 && <0.11), time, transformers, unix-compat, zlib [details]
License BSD-3-Clause
Author James Sanders, Shu-yu Guo, Gregory Collins, Doug Beardsley
Maintainer snap@snapframework.com
Category Web
Home page http://snapframework.com/
Source repo head: git clone http://git.snapframework.com/snap-core.git
Uploaded by GregoryCollins at 2010-10-26T23:44:37Z
Distributions Arch:1.0.5.1, Debian:1.0.4.2, Fedora:1.0.5.1, FreeBSD:0.9.7.2, LTSHaskell:1.0.5.1, NixOS:1.0.5.1, Stackage:1.0.5.1
Reverse Dependencies 72 direct, 147 indirect [details]
Executables snap
Downloads 128223 total (437 in the last 30 days)
Rating 2.5 (votes: 5) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs uploaded by user
Build status unknown [no reports yet]

Readme for snap-core-0.2.15

[back to package description]

Snap Framework Core

This is the first developer prerelease of the Snap Framework Core library. For more information about Snap, read the README.SNAP.md or visit the Snap project website at http://www.snapframework.com/.

Snap is a nascent web framework for Haskell, based on iteratee I/O (as popularized by Oleg Kiselyov).

Library contents

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.

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 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:

$ ./runTestsAndCoverage.sh

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