Bio.Iteratee.IO.Handle

Random and Binary IO with generic Iteratees. These functions use Handles for IO operations, and are provided for compatibility. When available, the File Descriptor based functions are preferred as these wastefully allocate memory rather than running in constant space.

File enumerators

enumHandle

Arguments

:: (MonadIO m, MonadMask m)

=> Int

Buffer size (number of elements per read)

-> Handle

-> Enumerator Bytes m a

The (monadic) enumerator of a file Handle. This version enumerates over the entire contents of a file, in order, unless stopped by the iteratee. In particular, seeking is not supported. Data is read into a buffer of the specified size.

enumHandleCatch

Arguments

:: (IException e, MonadIO m, MonadMask m)

=> Int

Buffer size (number of elements per read)

-> Handle

-> (e -> m (Maybe EnumException))

-> Enumerator Bytes m a

An enumerator of a file handle that catches exceptions raised by the Iteratee.

enumHandleRandom

Arguments

:: (MonadIO m, MonadMask m)

=> Int

Buffer size (number of elements per read)

-> Handle

-> Enumerator Bytes m a

The enumerator of a Handle: a variation of enumHandle that supports RandomIO (seek requests). Data is read into a buffer of the specified size.

enumFile

Arguments

:: (MonadIO m, MonadMask m)

=> Int

Buffer size

-> FilePath

-> Enumerator Bytes m a

enumFileRandom

Arguments

:: (MonadIO m, MonadMask m)

=> Int

Buffer size

-> FilePath

-> Enumerator Bytes m a

Iteratee drivers

fileDriverHandle

Arguments

:: (MonadIO m, MonadMask m)

=> Int

Buffer size (number of elements)

-> Iteratee Bytes m a

-> FilePath

-> m a

Process a file using the given Iteratee. This function wraps enumHandle as a convenience.

fileDriverRandomHandle

Arguments

:: (MonadIO m, MonadMask m)

=> Int

Buffer size (number of elements)

-> Iteratee Bytes m a

-> FilePath

-> m a

A version of fileDriverHandle that supports seeking.