Personal tools

Pipes

From HaskellWiki

(Difference between revisions)
Jump to: navigation, search
m (Pipe moved to Pipes over redirect: The Discussion page argues in detail why the name “Pipes” is preferred to “Pipe”, but in short, the library ecosystem which this page talks about better identifies itself with the name “Pipes”, and no)
(pipes-aeson)
(11 intermediate revisions by one user not shown)
Line 60: Line 60:
   
 
Source code hosted on [https://github.com/Gabriel439/Haskell-Pipes-Concurrency-Library GitHub]
 
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 ==
 
== 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 ===
 
=== 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 lazy parsing.
+
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]
 
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 ===
 
=== pipes-network ===
Line 74: Line 103:
   
 
Source code hosted on [https://github.com/k0001/pipes-network GitHub]
 
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 ===
 
=== pipes-zlib ===
Line 80: Line 115:
   
 
Source code hosted on [https://github.com/k0001/pipes-zlib GitHub]
 
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 ==
 
== Announcements ==
Line 109: Line 148:
 
* [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/forum/?fromgroups=#!topic/haskell-pipes/O4_5dZ7WwXE pipes-zlib-0.2.0.0]: Zlib compression/decompression support for pipes
   
== Upcoming libraries ==
+
* [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-parse: Parsing support for the pipes ecosystem
+
* [http://www.haskellforall.com/2013/06/pipes-parse-100-pushback-delimited.html pipes-parse-1.0.0]: Pushback, delimited parsers, resumable parsing, and lenses
   
* pipes-string: Bytestring and Text support
+
* [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.
   
* pipes-free: Pipe suspension and single-stepping pipes
+
* [https://groups.google.com/d/msg/haskell-pipes/2CQ9eiPUxjA/kBqcQboPdjoJ pipes-aeson-0.1.0.0]: Encode and decode JSON streams.
   
* pipes-network-tls: TLS-secured alternative to pipes-network
+
* [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.
   
* pipes-attoparsec: Improve the current pipes-attoparsec library by relying on the upcoming pipes-parse for interleaved parsing support.
+
== Upcoming libraries ==
  +
  +
* pipes-bytestring: ByteString support. Source code is hosted at [https://github.com/Gabriel439/Haskell-Pipes-ByteString-Library GitHub]
  +
  +
* pipes-text: Text support
  +
  +
* pipes-free: Pipe suspension and single-stepping pipes

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.

Contents

1 Libraries

Pipes is the official Hackage category for the pipes ecosystem.

1.1 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

1.2 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

1.3 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

1.4 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

2 Community-contributed libraries

Listed in alphabetical order.

2.1 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

2.2 pipes-attoparsec

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

Source code hosted on GitHub

2.3 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

2.4 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

2.5 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

2.6 pipes-zlib

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

Source code hosted on GitHub

3 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.

4 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.

5 Upcoming libraries

  • pipes-bytestring: ByteString support. Source code is hosted at GitHub
  • pipes-text: Text support
  • pipes-free: Pipe suspension and single-stepping pipes