jonathanknowles / pipes-progress Goto Github PK

An experimental library that provides primitives for monitoring the progress of streaming computations, compatible with the Haskell Pipes ecosystem.

Please note that this library is still experimental and in development. Using it may corrupt all the files on your hard disk or even cause your car to catch fire (although it probably won't).

When performing a streaming computation, it's often desirable to have some way of monitoring the progress of that computation. This is especially the case for computations initiated through a user interface, where it's important to give the user an idea of how much progress has been made, and how much work is left.

This package provides convenient primitives for building both monitorable computations and monitors, as well as providing functions that connect computations and monitors together, so that:

• progress can be reported on a regular basis, even in situations where the underlying computation has stalled;

• concurrency issues created by reading the changing state of a computation are handled correctly and safely;

• termination is handled automatically: when the underlying computation terminates, the monitor is notified immediately with the final status of the computation.

For more details, take a look at the Pipes.Progress module, which contains a detailed description of the evaluation model.

stack build

For a demonstration of how to use the library, see the code examples within the pipes-progress-examples package.