| ||||||||||||||
| ||||||||||||||
| ||||||||||||||
Description | ||||||||||||||
Byte-oriented alternatives to Data.Enumerator.List. Note that the enumeratees in this module must unpack their inputs to work properly. If you do not need to handle leftover input on a byte-by-byte basis, the chunk-oriented versions will be much faster. This module is intended to be imported qualified: import qualified Data.Enumerator.Binary as EB Since: 0.4.5 | ||||||||||||||
Synopsis | ||||||||||||||
IO | ||||||||||||||
| ||||||||||||||
| ||||||||||||||
| ||||||||||||||
| ||||||||||||||
| ||||||||||||||
Opens a file path in binary mode, and passes the handle to enumHandle. The file will be closed when enumeration finishes. Since: 0.4.5 | ||||||||||||||
| ||||||||||||||
| ||||||||||||||
| ||||||||||||||
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. Since: 0.4.5 | ||||||||||||||
List analogues | ||||||||||||||
Folds | ||||||||||||||
| ||||||||||||||
Consume the entire input stream with a strict left fold, one byte at a time. Since: 0.4.8 | ||||||||||||||
| ||||||||||||||
Consume the entire input stream with a strict monadic left fold, one byte at a time. Since: 0.4.8 | ||||||||||||||
Maps | ||||||||||||||
| ||||||||||||||
map f applies f to each input byte and feeds the resulting outputs to the inner iteratee. Since: 0.4.8 | ||||||||||||||
| ||||||||||||||
mapM f applies f to each input byte and feeds the resulting outputs to the inner iteratee. Since: 0.4.8 | ||||||||||||||
| ||||||||||||||
mapM_ f applies f to each input byte, and discards the results. Since: 0.4.11 | ||||||||||||||
| ||||||||||||||
concatMap f applies f to each input byte and feeds the resulting outputs to the inner iteratee. Since: 0.4.8 | ||||||||||||||
| ||||||||||||||
concatMapM f applies f to each input byte and feeds the resulting outputs to the inner iteratee. Since: 0.4.8 | ||||||||||||||
Accumulating maps | ||||||||||||||
| ||||||||||||||
Similar to map, but with a stateful step function. Since: 0.4.9 | ||||||||||||||
| ||||||||||||||
Similar to mapM, but with a stateful step function. Since: 0.4.9 | ||||||||||||||
| ||||||||||||||
Similar to concatMap, but with a stateful step function. Since: 0.4.11 | ||||||||||||||
| ||||||||||||||
Similar to concatMapM, but with a stateful step function. Since: 0.4.11 | ||||||||||||||
Infinite streams | ||||||||||||||
| ||||||||||||||
iterate f x enumerates an infinite stream of repeated applications of f to x. Analogous to iterate. Since: 0.4.8 | ||||||||||||||
| ||||||||||||||
Similar to iterate, except the iteration function is monadic. Since: 0.4.8 | ||||||||||||||
| ||||||||||||||
Enumerates an infinite stream of a single byte. Analogous to repeat. Since: 0.4.8 | ||||||||||||||
| ||||||||||||||
Enumerates an infinite stream of byte. Each byte is computed by the underlying monad. Since: 0.4.8 | ||||||||||||||
Bounded streams | ||||||||||||||
| ||||||||||||||
replicate n x enumerates a stream containing n copies of x. Since: 0.4.8 | ||||||||||||||
| ||||||||||||||
replicateM n m_x enumerates a stream of n bytes, with each byte computed by m_x. Since: 0.4.8 | ||||||||||||||
| ||||||||||||||
Like repeatM, except the computation may terminate the stream by returning Nothing. Since: 0.4.8 | ||||||||||||||
| ||||||||||||||
Enumerates a stream of bytes by repeatedly applying a function to some state. Similar to iterate. Since: 0.4.8 | ||||||||||||||
| ||||||||||||||
Enumerates a stream of bytes by repeatedly applying a computation to some state. Similar to iterateM. Since: 0.4.8 | ||||||||||||||
Filters | ||||||||||||||
| ||||||||||||||
Applies a predicate to the stream. The inner iteratee only receives characters for which the predicate is True. Since: 0.4.8 | ||||||||||||||
| ||||||||||||||
Applies a monadic predicate to the stream. The inner iteratee only receives bytes for which the predicate returns True. Since: 0.4.8 | ||||||||||||||
Consumers | ||||||||||||||
| ||||||||||||||
take n extracts the next n bytes from the stream, as a lazy ByteString. Since: 0.4.5 | ||||||||||||||
| ||||||||||||||
takeWhile p extracts input from the stream until the first byte which does not match the predicate. Since: 0.4.5 | ||||||||||||||
| ||||||||||||||
consume = takeWhile (const True) Since: 0.4.5 | ||||||||||||||
Unsorted | ||||||||||||||
| ||||||||||||||
Get the next byte from the stream, or Nothing if the stream has ended. Since: 0.4.5 | ||||||||||||||
| ||||||||||||||
drop n ignores n bytes of input from the stream. Since: 0.4.5 | ||||||||||||||
| ||||||||||||||
dropWhile p ignores input from the stream until the first byte which does not match the predicate. Since: 0.4.5 | ||||||||||||||
| ||||||||||||||
require n buffers input until at least n bytes are available, or throws an error if the stream ends early. Since: 0.4.5 | ||||||||||||||
| ||||||||||||||
isolate n reads at most n bytes from the stream, and passes them to its iteratee. If the iteratee finishes early, bytes continue to be consumed from the outer stream until n have been consumed. Since: 0.4.5 | ||||||||||||||
| ||||||||||||||
Split on bytes satisfying a given predicate. Since: 0.4.8 | ||||||||||||||
Produced by Haddock version 2.6.1 |