Hackage :: [Package]

snap-core: Snap: A Haskell Web Framework (core interfaces and types)

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

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. A monad for programming web handlers called "Snap", 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.Core.

[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
debug

Enable debug logging code. With 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.

Disabled
network-uri

Get Network.URI from the network-uri package

Enabled

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

Downloads

Note: This package has metadata revisions in the cabal description newer than included in the tarball. To unpack the package including the revisions, use 'cabal get'.

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
Change log changelog.md
Dependencies attoparsec (>=0.12 && <0.15), base (>=4 && <5), bytestring (>=0.9 && <0.13), bytestring-builder (>=0.10.4 && <0.11), case-insensitive (>=1.1 && <1.3), containers (>=0.3 && <1), directory (>=1 && <2), fail (>=4.9 && <4.10), filepath (>=1.1 && <2), hashable (>=1.2.0.6 && <2), HUnit (>=1.2 && <2), io-streams (>=1.3 && <1.6), lifted-base (>=0.1 && <0.3), monad-control (>=1.0 && <1.1), mtl (>=2.0 && <2.4), network (>=2.3 && <4), network-uri (>=2.5 && <2.7), old-locale (>=1 && <2), random (>=1 && <2), readable (>=0.1 && <0.4), regex-posix (>=0.95 && <1), semigroups (>=0.18 && <0.20), text (>=0.11 && <2.2), time (>=1.0 && <1.15), time-locale-compat (>=0.1 && <0.2), transformers (>=0.3 && <0.7), transformers-base (>=0.4 && <0.5), unix-compat (>=0.3 && <0.8), unordered-containers (>=0.1.4.3 && <0.3), vector (>=0.6 && <0.14) [details]
Tested with ghc ==8.8.4, ghc ==8.10.7, ghc ==9.0.2, ghc ==9.2.8, ghc ==9.4.7, ghc ==9.6.3, ghc ==9.8.1
License BSD-3-Clause
Author Snap Framework Authors (see CONTRIBUTORS)
Maintainer snap@snapframework.com
Revised Revision 6 made by cydparser at 2024-07-04T22:39:46Z
Category Web, Snap, IO-Streams
Home page http://snapframework.com/
Bug tracker https://github.com/snapframework/snap-core/issues
Source repo head: git clone git://github.com/snapframework/snap-core.git
Uploaded by cydparser at 2023-02-10T21:32:56Z
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]
Downloads 128307 total (445 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-1.0.5.1

[back to package description]

Snap Framework Core

GitHub CI

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.