Transient.Stream.Resource

Documentation

sourceFile :: String -> TransIO String

slurp input from a file a line at a time. It creates as much threads as possible. to allow single threaded processing, use it with `threads 0`

sinkFile :: TransIO String -> String -> TransIO ()

Stream the input to a file

process :: TransIO a -> IO handle -> (handle -> IO ()) -> (handle -> a -> TransIO (StreamData b)) -> TransIO b

is the general operation for processing a streamed input, with opening resources before processing and closing them when finish is called. The process statements suscribe to the EVar Finish.

when this variable is updated, the close section is called.

When the processing return SDone or SError, the Finish variable is updated so all the subscribed code that close the resources are executed.

finish :: TransIO ()

trigger the event for the closing of all the resources

onFinish :: TransIO () -> TransIO a

suscribe a computation to be called when the finish event is triggered