Data.Enumerator.IO

Enumerator-based IO

Documentation

enumHandle

Arguments

:: Integer

Buffer size

-> Handle

-> Enumerator SomeException ByteString IO b

Read bytes (in chunks of the given buffer size) from the handle, and stream them to an Iteratee. If an exception occurs during file IO, enumeration will stop and Error will be returned. Exceptions from the iteratee are not caught.

This enumerator blocks until at least one byte is available from the handle, and might read less than the maximum buffer size in some cases.

The handle should be opened with no encoding, and in ReadMode or ReadWriteMode.

enumFile :: FilePath -> Enumerator SomeException ByteString IO b

Opens a file path in binary mode, and passes the handle to enumHandle. The file will be closed when the Iteratee finishes.

iterHandle :: Handle -> Iteratee SomeException ByteString IO ()

Read bytes from a stream and write them to a handle. If an exception occurs during file IO, enumeration will stop and Error will be returned.

The handle should be opened with no encoding, and in WriteMode or ReadWriteMode.