pipes-safe: Safety for the pipes ecosystem

This is a package candidate release! Here you can preview how this package release will appear once published to the main package index (which can be accomplished via the 'maintain' link below). Please note that once a package has been published to the main package index it cannot be undone! Please consult the package uploading documentation for more information.

[maintain] [Publish]

Warnings:

'ghc-options: -O2' is rarely needed. Check that it is giving a real benefit and not just imposing longer compile times on your users.

This package adds resource management and exception handling to the pipes ecosystem.

Notable features include:

Resource Safety: Guarantee finalization using finally, bracket and more
Exception Safety: Even against asynchronous exceptions!
Laziness: Only acquire resources when you need them
Promptness: Finalize resources early when you are done with them
Native Exception Handling: Catch and resume from exceptions inside pipes
No Buy-in: Mix resource-safe pipes with unmanaged pipes using hoist

[Skip to Readme]

Properties

Versions	1.0.0, 1.1.0, 1.2.0, 2.0.0, 2.0.1, 2.0.2, 2.1.0, 2.2.0, 2.2.1, 2.2.2, 2.2.3, 2.2.4, 2.2.5, 2.2.6, 2.2.7, 2.2.8, 2.2.9, 2.3.0, 2.3.1, 2.3.2, 2.3.3, 2.3.4, 2.3.5
Change log	changelog.md
Dependencies	base (>=4 && <5), containers (>=0.3.0.0 && <0.6), exceptions (>=0.6 && <0.10), monad-control (>=1.0.0.4 && <1.1), mtl (>=2.1 && <2.3), pipes (>=4.3.0 && <4.4), primitive (>=0.6.2.0 && <0.7), transformers (>=0.2.0.0 && <0.6), transformers-base (>=0.4.4 && <0.5) [details]
License	BSD-3-Clause
Copyright	2013, 2014 Gabriel Gonzalez
Author	Gabriel Gonzalez
Maintainer	Gabriel439@gmail.com
Category	Control, Pipes, Error Handling
Bug tracker	https://github.com/Gabriel439/Haskell-Pipes-Safe-Library/issues
Source repo	head: git clone https://github.com/Gabriel439/Haskell-Pipes-Safe-Library
Uploaded	by GabrielGonzalez at 2018-02-26T17:47:49Z

Modules

Pipes
- Pipes.Safe
  - Pipes.Safe.Prelude

Downloads

pipes-safe-2.2.7.tar.gz [browse] (Cabal source package)
Package description (as included in the package)

Maintainer's Corner

Package maintainers

GabrielGonzalez

For package maintainers and hackage trustees

edit package information

Readme for pipes-safe-2.2.7

[back to package description]

Pipes-Safe v2.2.7

pipes-safe builds upon the pipes library to provide exception safety and resource management.

Quick start

Install the Haskell Platform
cabal install pipes-safe

The official tutorial is on Hackage.

Features

Resource Safety: Guarantee finalization using finally, bracket, and more
Exception Safety: Even against asynchronous exceptions!
Laziness: Only acquire resources when you need them
Promptness: Finalize resources early when you are done with them
Native Exception Handling: Catch and resume from exceptions inside pipes
No Buy-in: Mix resource-safe pipes with unmanaged pipes using hoist

Outline

Use pipes-safe for production code where you need deterministic and prompt release of resources in the fact of exceptions or premature pipe termination. pipes-safe lets you safely acquire resources and handle exceptions within pipelines.

Development Status

pipes-safe is mostly stable. Research into prompter finalization alternatives will take place in a separate library.

Community Resources

Use the same resources as the core pipes library to learn more, contribute, or request help:

How to contribute

Build derived libraries
Write pipes-safe tutorials

License (BSD 3-clause)

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
Neither the name of Gabriel Gonzalez nor the names of other contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.