Difference between revisions of "Pipes"

From HaskellWiki
Jump to navigation Jump to search
(Created a stub with several links)
 
(22 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
{{Stub}}
  
−  
 
[[Category:Idioms]]
  
[[Category:Idioms]]
  +
[[Category:Libraries]]
  +
[[Category:Packages]]
  +
  +
Use pipes to create elegant streaming programs within Haskell. Build streaming components and connect them them together to process both events and data.
  +
  +
== Libraries ==
  +
  +
[http://hackage.haskell.org/packages/archive/pkg-list.html#cat:pipes Pipes] is the official Hackage category for the pipes ecosystem.
  +
  +
=== pipes ===
  +
  +
The [http://hackage.haskell.org/package/pipes pipes] package is the core library which emphasizes:
  +
  +
* Elegance and Simplicity
  +
* Speed
  +
* Lightweight dependencies
  +
  +
The pipes library offers many unique features not available in other streaming libraries:
  +
  +
* Bidirectional streams
  +
* Extension framework
  +
* Elegant ListT interconversions
  +
* Correctness proofs for the entire library
  +
  +
Read the [http://hackage.haskell.org/packages/archive/pipes/3.2.0/doc/html/Control-Proxy-Tutorial.html official pipes tutorial] to learn more.
  +
  +
Source code hosted on [https://github.com/Gabriel439/Haskell-Pipes-Library GitHub]
  +
  +
=== pipes-safe ===
  +
  +
The [http://hackage.haskell.org/package/pipes-safe pipes-safe] package adds resource management and exception safety to the pipes ecosystem. pipes-safe offers many high-level features such as:
  +
  +
* Complete exception safety, including asynchronous exceptions
  +
* Termination safety
  +
* Resources are freed in reverse order of acquisition
  +
  +
Additionally, pipes-safe is the only streaming library that provides truly native exception handling, allowing you to seamlessly handle exceptions and resume uninterrupted streaming.
  +
  +
Read the [http://hackage.haskell.org/packages/archive/pipes-safe/1.1.0/doc/html/Control-Proxy-Safe-Tutorial.html official pipes-safe tutorial] to learn more.
  +
  +
Source code hosted on [https://github.com/Gabriel439/Haskell-Pipes-Safe-Library GitHub]
  +
  +
=== pipes-concurrency ===
  +
  +
The [http://hackage.haskell.org/package/pipes-concurrency pipes-concurrency] package adds powerful and light-weight concurrency primitives to the pipes ecosystem. Use these primitives to:
  +
  +
* Build reactive event-driven programs
  +
* Merge and split streams
  +
* Communicate between multiple concurrent pipelines
  +
* Manage multiple resources simultaneously
  +
  +
The pipes-concurrency library offers several features unavailable in other streaming libraries such as:
  +
  +
* Deadlock safety
  +
* Cyclic communication graphs
  +
* Dynamically changing graph topologies
  +
  +
Read the [http://hackage.haskell.org/packages/archive/pipes-concurrency/1.0.0/doc/html/Control-Proxy-Concurrent-Tutorial.html official pipes-concurrency tutorial] to learn more.
  +
  +
Source code hosted on [https://github.com/Gabriel439/Haskell-Pipes-Concurrency-Library GitHub]
  +
  +
=== pipes-parse ===
  +
  +
The [http://hackage.haskell.org/package/pipes-parse pipes-parse] package defines the generic machinery necessary for common parsing tasks using pipes:
  +
  +
* Detect and handle end of input
  +
* Save unused input for later steps
  +
* Mix proxies with different leftover buffers using lenses
  +
* Nesting and delimiting parsers to a subset of the input
  +
* Interruptible and resumable parsing
  +
  +
Read the [http://hackage.haskell.org/packages/archive/pipes-parse/latest/doc/html/Control-Proxy-Parse-Tutorial.html official pipes-parse tutorial] to learn more.
  +
  +
Source code hosted on [https://github.com/Gabriel439/Haskell-Pipes-Parse-Library GitHub]
  +
  +
== Community-contributed libraries ==
  +
  +
Listed in alphabetical order.
  +
  +
=== pipes-aeson ===
  +
  +
The [http://hackage.haskell.org/package/pipes-aeson pipes-aeson] library allows you to encode and decode JSON values flowing through streams, possibly
  +
interleaving other stream effects while doing it.
  +
  +
Source code is hosted on [https://github.com/k0001/pipes-aeson GitHub]
  +
  +
=== pipes-attoparsec ===
  +
  +
The [http://hackage.haskell.org/package/pipes-attoparsec pipes-attoparsec] library converts [http://hackage.haskell.org/package/attoparsec attoparsec] parsers to pipes for high-performance incremental parsing.
  +
  +
Source code hosted on [https://github.com/k0001/pipes-attoparsec GitHub]
  +
  +
=== pipes-binary ===
  +
  +
The [http://hackage.haskell.org/package/pipes-binary pipes-binary] library allows streams of binary data to be encoded and decoded using the <code>Binary</code> instances from the [http://hackage.haskell.org/package/binary binary] package.
  +
  +
Source code is hosted on [https://github.com/k0001/pipes-binary GitHub]
  +
  +
=== pipes-network ===
  +
  +
The [http://hackage.haskell.org/package/pipes-network pipes-network] library converts server and client sockets to pipes to seamlessly stream data over any network.
  +
  +
Source code hosted on [https://github.com/k0001/pipes-network GitHub]
  +
  +
=== pipes-network-tls ===
  +
  +
The [http://hackage.haskell.org/package/pipes-network-tls pipes-network-tls] allows streaming through TLS-secured network connections, exposing a similar API to the one exposed by [http://hackage.haskell.org/package/pipes-network pipes-network].
  +
  +
Source code hosted on [https://github.com/k0001/pipes-network-tls GitHub]
  +
  +
=== pipes-zlib ===
  +
  +
The [http://hackage.haskell.org/package/pipes-zlib pipes-zlib] enables compression and decompression of strict ByteString streams using the zlib codec.
  +
  +
Source code hosted on [https://github.com/k0001/pipes-zlib GitHub]
  +
  +
== Community ==
  +
  +
Besides the usual Haskell community channels such as the [[Mailing_lists|official mailing lists]] or the [http://reddit.com/r/haskell Haskell subreddit], you can ask for help, suggest improvements, or discuss about the Pipes ecosystem at the [https://groups.google.com/group/haskell-pipes “haskell-pipes” mailing list at Google Groups].
  +
  +
== Announcements ==
  +
  +
In chronological order.
  +
  +
* [http://www.reddit.com/r/haskell/comments/ohjg7/a_new_approach_to_iteratees/ pipes-1.0.0]: The original announcement, which first introduced the concept of unifying sources and sinks and transducers into a single [http://www.haskell.org/ghc/docs/latest/html/libraries/base/Control-Category.html Category].
  +
  +
* [http://www.haskellforall.com/2012/05/pipes-20-pipe-finalization.html pipes-2.0.0]: The introduction of Frames, later deprecated in favor of pipes-safe.
  +
  +
* [http://www.haskellforall.com/2012/07/pipes-21-and-index-core-10-indexed.html pipes-2.1.0]: Transition of Frames to indexed monads, later deprecated in favor of pipes-safe.
  +
  +
* [http://www.haskellforall.com/2012/09/pipes-23-bidirectional-pipes.html pipes-2.3.0]: The introduction of bidirectional Proxies, which evolved into modern pipes.
  +
  +
* [http://www.haskellforall.com/2012/10/pipes-24-proxy-transformers-extra.html pipes-2.4.0]: The release of the proxy transformer extension system.
  +
  +
* [http://www.haskellforall.com/2012/10/pipes-25-faster-and-slimmer.html pipes-2.5.0]: Major performance improvements.
  +
  +
* [http://www.haskellforall.com/2012/12/pipes-30-simpler-unified-api.html pipes-3.0.0]: Major API simplification and consolidation.
  +
  +
* [http://www.haskellforall.com/2013/01/pipes-safe-10-resource-management-and.html pipes-safe-1.0.0]: Resource safety and exception management
  +
  +
* [http://www.haskell.org/pipermail/haskell-cafe/2013-March/106752.html pipes-network-0.1.0]: Use TCP network sockets as pipes streams.
  +
  +
* [http://www.haskellforall.com/2013/03/pipes-32-listt-codensity-arrowchoice.html pipes-3.2.0]: ListT integration, Codensity proxy transformer, and ArrowChoice primitives.
  +
  +
* [http://www.haskellforall.com/2013/04/pipes-concurrency-100-reactive.html pipes-concurrency-1.0.0]: Concurrency support for pipes
  +
  +
* [https://groups.google.com/forum/?fromgroups=#!topic/haskell-pipes/O4_5dZ7WwXE pipes-zlib-0.2.0.0]: Zlib compression/decompression support for pipes
   
  +
* [https://groups.google.com/d/msg/haskell-pipes/XGb-8x5YWY0/41BUbJagnuEJ pipes-network-tls-0.1.0.0]: Stream through TLS-secured network connections.
−
Pipes are a way to handle streaming data.
  
   
  +
* [http://www.haskellforall.com/2013/06/pipes-parse-100-pushback-delimited.html pipes-parse-1.0.0]: Pushback, delimited parsers, resumable parsing, and lenses
   
  +
* [https://groups.google.com/d/msg/haskell-pipes/3A-RbzCUovw/9GEIDi5WRbwJ pipes-attoparsec-0.2.0.0]: New API, interleaved parsing support, built on top of pipes-parse.
−
== Links ==
  
   
  +
* [https://groups.google.com/d/msg/haskell-pipes/2CQ9eiPUxjA/kBqcQboPdjoJ pipes-aeson-0.1.0.0]: Encode and decode JSON streams.
−
* [http://hackage.haskell.org/package/pipes The pipe package] on Hackage
  
−
* [http://hackage.haskell.org/packages/archive/pkg-list.html#cat:enumerator Pipes packages] on Hackage
  
   
  +
* [https://groups.google.com/d/msg/haskell-pipes/7I8KcMW3zHU/5Mi8PKbuv2sJ pipes-binary-0.1.0.0]: Encode and decode binary streams using the <code>binary</code> package.
   
−
=== Blog articles ===
 +
== Upcoming libraries ==
   
  +
* pipes-bytestring: ByteString support. Source code is hosted at [https://github.com/Gabriel439/Haskell-Pipes-ByteString-Library GitHub]
−
* [https://pcapriotti.wordpress.com/2012/02/02/an-introduction-to-guarded-pipes/ An introduction to guarded pipes]
  
−
* [http://www.haskellforall.com/2012/03/haskell-for-purists-pipe-finalization.html Haskell for Purists - Pipe Finalization]
  
−
* [http://www.haskellforall.com/2012/05/pipes-20-pipe-finalization.html pipes 2.0 - Pipe Finalization]
  
−
* [https://pcapriotti.wordpress.com/2012/02/04/monoidal-instances-for-pipes/ Monoidal instances for pipes]
  
   
  +
* pipes-text: Text support
   
  +
* pipes-free: Pipe suspension and single-stepping pipes
−
=== See also ===
  
−
* [[Conduit]]
  
−
* [[Enumerator and iteratee]]
  
−
* [[Iteratee I/O]]
  
−
* [[Iteratee]]
  

Revision as of 06:26, 11 June 2013


Use pipes to create elegant streaming programs within Haskell. Build streaming components and connect them them together to process both events and data.

Libraries

Pipes is the official Hackage category for the pipes ecosystem.

pipes

The pipes package is the core library which emphasizes:

  • Elegance and Simplicity
  • Speed
  • Lightweight dependencies

The pipes library offers many unique features not available in other streaming libraries:

  • Bidirectional streams
  • Extension framework
  • Elegant ListT interconversions
  • Correctness proofs for the entire library

Read the official pipes tutorial to learn more.

Source code hosted on GitHub

pipes-safe

The pipes-safe package adds resource management and exception safety to the pipes ecosystem. pipes-safe offers many high-level features such as:

  • Complete exception safety, including asynchronous exceptions
  • Termination safety
  • Resources are freed in reverse order of acquisition

Additionally, pipes-safe is the only streaming library that provides truly native exception handling, allowing you to seamlessly handle exceptions and resume uninterrupted streaming.

Read the official pipes-safe tutorial to learn more.

Source code hosted on GitHub

pipes-concurrency

The pipes-concurrency package adds powerful and light-weight concurrency primitives to the pipes ecosystem. Use these primitives to:

  • Build reactive event-driven programs
  • Merge and split streams
  • Communicate between multiple concurrent pipelines
  • Manage multiple resources simultaneously

The pipes-concurrency library offers several features unavailable in other streaming libraries such as:

  • Deadlock safety
  • Cyclic communication graphs
  • Dynamically changing graph topologies

Read the official pipes-concurrency tutorial to learn more.

Source code hosted on GitHub

pipes-parse

The pipes-parse package defines the generic machinery necessary for common parsing tasks using pipes:

  • Detect and handle end of input
  • Save unused input for later steps
  • Mix proxies with different leftover buffers using lenses
  • Nesting and delimiting parsers to a subset of the input
  • Interruptible and resumable parsing

Read the official pipes-parse tutorial to learn more.

Source code hosted on GitHub

Community-contributed libraries

Listed in alphabetical order.

pipes-aeson

The pipes-aeson library allows you to encode and decode JSON values flowing through streams, possibly interleaving other stream effects while doing it.

Source code is hosted on GitHub

pipes-attoparsec

The pipes-attoparsec library converts attoparsec parsers to pipes for high-performance incremental parsing.

Source code hosted on GitHub

pipes-binary

The pipes-binary library allows streams of binary data to be encoded and decoded using the Binary instances from the binary package.

Source code is hosted on GitHub

pipes-network

The pipes-network library converts server and client sockets to pipes to seamlessly stream data over any network.

Source code hosted on GitHub

pipes-network-tls

The pipes-network-tls allows streaming through TLS-secured network connections, exposing a similar API to the one exposed by pipes-network.

Source code hosted on GitHub

pipes-zlib

The pipes-zlib enables compression and decompression of strict ByteString streams using the zlib codec.

Source code hosted on GitHub

Community

Besides the usual Haskell community channels such as the official mailing lists or the Haskell subreddit, you can ask for help, suggest improvements, or discuss about the Pipes ecosystem at the “haskell-pipes” mailing list at Google Groups.

Announcements

In chronological order.

  • pipes-1.0.0: The original announcement, which first introduced the concept of unifying sources and sinks and transducers into a single Category.
  • pipes-2.0.0: The introduction of Frames, later deprecated in favor of pipes-safe.
  • pipes-2.1.0: Transition of Frames to indexed monads, later deprecated in favor of pipes-safe.
  • pipes-2.3.0: The introduction of bidirectional Proxies, which evolved into modern pipes.
  • pipes-2.4.0: The release of the proxy transformer extension system.
  • pipes-3.0.0: Major API simplification and consolidation.
  • pipes-3.2.0: ListT integration, Codensity proxy transformer, and ArrowChoice primitives.

Upcoming libraries

  • pipes-bytestring: ByteString support. Source code is hosted at GitHub
  • pipes-text: Text support
  • pipes-free: Pipe suspension and single-stepping pipes
Retrieved from "https://wiki.haskell.org/index.php?title=Pipes&oldid=56245"