A resource management decorator for "streaming"

This package provides a decorator for the Stream type from "streaming", that lets you perform bracket-like operations that allocate and deallocate resources used by the stream.

By carefully managing the operations that are lifted to the decorated streams, we can ensure that finalizers are promptly called even with operations like "take", which do not consume the whole stream.

streaming-bracketed

What's this?

A resource management "decorator" for the Stream type from streaming.

The idea is that the Bracketed type represents a Stream which might have some finalizers that will be triggered when we reach a given point in the stream.

By being careful about how we lift operations to work on Bracketed streams, we can ensure that finalizers are promptly called even with operations like take.

Bracketed streams are ultimately consumed by using a continuation.

Differences with resourcet

resourcet is a widely used library for resource handling. It provides a monad transformer over IO that keeps track of registered resources and ensures proper cleanup.

The main differences with the present library are:

• This library only works on Streams from streaming.

• Bracketed sits above the streaming monad, not below like ResourceT.

• This library aims to provide smarter handling of stream functions like take, without too much hassle.

• In this library finalizer scopes are nested, unlike ResourceT which allows arbitrary interleavings.

Doubts

• Lifting functions like splitAt might cause problems if we try to use the rest of the stream.

Motivation

From the CHANGELOG of the streaming package:

Remove bracketStream, MonadCatch instance, and everything dealing with
ResourceT. All of these things of sort of broken for Stream since there is no
guarantee of linear consumption (functions like take can prevent finalizers
from running).

One Github issue.

Another one.

Streaming libs exercise/challenge:

Given a list [(Filepath,Int,Int)] of files and line ranges, create a stream
of lines belonging to the concatenated ranges.

Prompt release of file handles is required. resource-handling monads and
"withXXX"-style functions are allowed.