enumerator-0.4.0.1: Implementation of Oleg Kiselyov's left-fold enumerators

Portabilityportable
Maintainer[email protected]

Data.Enumerator

Contents

Description

An implementation of Oleg Kiselyov’s left-fold enumerators

Synopsis

Types

data Stream a Source

Not to be confused with types from the Stream or stream-fusion packages, a Stream is a sequence of chunks generated by an Enumerator. In contrast to Oleg’s implementation, this stream does not support error handling -- errors encountered while generating a stream are reported in the Step type instead.

(Chunks []) is used to indicate that a stream is still active, but currently has no available data. Iteratees should ignore empty chunks.

Constructors

Chunks [a] 
EOF 

Instances

data Step a m b Source

Constructors

Continue (Stream a -> Iteratee a m b)

The Iteratee is capable of accepting more input. Note that more input is not necessarily required; the Iteratee might be able to generate a value immediately if it receives EOF.

Yield b (Stream a)

The Iteratee has received enough input to generate a result. Included in this value is left-over input, which can be passed to composed Iteratees.

Error SomeException

The Iteratee encountered an error which prevents it from proceeding further.

newtype Iteratee a m b Source

The primary data type for this library, which consumes input from a Stream until it either generates a value or encounters an error. Rather than requiring all input at once, an iteratee will return Continue when it is capable of processing more data.

In general, iteratees begin in the Continue state. As each chunk is passed to the continuation, the iteratee returns the next step: Continue for more data, Yield when it's finished, or Error to abort processing.

Constructors

Iteratee 

Fields

runIteratee :: m (Step a m b)
 

Instances

type Enumerator a m b = Step a m b -> Iteratee a m bSource

While Iteratees consume data, enumerators generate it. Since Iteratee is an alias for m (Step a m b), Enumerators can be considered step transformers of type Step a m b -> m (Step a m b).

Enumerators typically read from an external source (parser, handle, random generator, etc). They feed chunks into an Iteratee until the source runs out of data (triggering EOF) or the iteratee finishes processing (Yields a value).

type Enumeratee aOut aIn m b = Step aIn m b -> Iteratee aOut m (Step aIn m b)Source

In cases where an enumerator acts as both a source and sink, the resulting type is named an Enumeratee. Enumeratees have two input types, “outer a” (aOut) and “inner a” (aIn).

Primitives

Combinators

These are common patterns which occur whenever iteratees are being defined.

returnI :: Monad m => Step a m b -> Iteratee a m bSource

returnI x = Iteratee (return x)

yield :: Monad m => b -> Stream a -> Iteratee a m bSource

yield x chunk = returnI (Yield x chunk)

continue :: Monad m => (Stream a -> Iteratee a m b) -> Iteratee a m bSource

continue k = returnI (Continue k)

throwError :: (Monad m, Exception e) => e -> Iteratee a m bSource

throwError err = returnI (Error err)

catchError :: Monad m => Iteratee a m b -> (SomeException -> Iteratee a m b) -> Iteratee a m bSource

liftI :: Monad m => (Stream a -> Step a m b) -> Iteratee a m bSource

liftI f = continue (returnI . f)

(>>==) :: Monad m => Iteratee a m b -> (Step a m b -> Iteratee a' m b') -> Iteratee a' m b'Source

Equivalent to (>>=), but allows Iteratees with different input types to be composed.

(==<<) :: Monad m => (Step a m b -> Iteratee a' m b') -> Iteratee a m b -> Iteratee a' m b'Source

(==<<) = flip (>>==)

($$) :: Monad m => (Step a m b -> Iteratee a' m b') -> Iteratee a m b -> Iteratee a' m b'Source

($$) = (==<<)

This might be easier to read when passing a chain of iteratees to an enumerator.

(>==>) :: Monad m => Enumerator a m b -> (Step a m b -> Iteratee a' m b') -> Step a m b -> Iteratee a' m b'Source

(>==>) e1 e2 s = e1 s >>== e2

(<==<) :: Monad m => (Step a m b -> Iteratee a' m b') -> Enumerator a m b -> Step a m b -> Iteratee a' m b'Source

(<==<) = flip (>==>)

Iteratees

run :: Monad m => Iteratee a m b -> m (Either SomeException b)Source

Run an iteratee until it finishes, and return either the final value (if it succeeded) or the error (if it failed).

run_ :: Monad m => Iteratee a m b -> m bSource

consume :: Monad m => Iteratee a m [a]Source

Consume all input until EOF, then return consumed input as a list.

isEOF :: Monad m => Iteratee a m BoolSource

Return True if the next Stream is EOF.

liftTrans :: (Monad m, MonadTrans t, Monad (t m)) => Iteratee a m b -> Iteratee a (t m) bSource

Lift an Iteratee onto a monad transformer, re-wrapping the Iteratee’s inner monadic values.

liftFoldL :: Monad m => (b -> a -> b) -> b -> Iteratee a m bSource

Lifts a pure left fold into an iteratee.

liftFoldL' :: Monad m => (b -> a -> b) -> b -> Iteratee a m bSource

As liftFoldL, but strict in its accumulator.

liftFoldM :: Monad m => (b -> a -> m b) -> b -> Iteratee a m bSource

Lifts a monadic left fold into an iteratee.

printChunks :: (MonadIO m, Show a) => Bool -> Iteratee a m ()Source

Print chunks as they're received from the enumerator, optionally printing empty chunks.

Enumerators

enumEOF :: Monad m => Enumerator a m bSource

The most primitive enumerator; simply sends EOF. The iteratee must either yield a value or throw an error continuing receiving EOF will not terminate with any useful value.

enumList :: Monad m => Integer -> [a] -> Enumerator a m bSource

Another small, useful enumerator separates an input list into chunks, and sends them to the iteratee. This is useful for testing iteratees in pure code.

concatEnums :: Monad m => [Enumerator a m b] -> Enumerator a m bSource

Compose a list of Enumerators using '(>>==)'

Enumeratees

checkDone :: Monad m => ((Stream a -> Iteratee a m b) -> Iteratee a' m (Step a m b)) -> Enumeratee a' a m bSource

A common pattern in Enumeratee implementations is to check whether the inner Iteratee has finished, and if so, to return its output. checkDone passes its parameter a continuation if the Iteratee can still consume input, or yields otherwise.

map :: Monad m => (ao -> ai) -> Enumeratee ao ai m bSource

sequence :: Monad m => Iteratee ao m ai -> Enumeratee ao ai m bSource

joinI :: Monad m => Iteratee a m (Step a' m b) -> Iteratee a m bSource

joinI is used to “flatten” Enumeratees into an Iteratee.

Parser combinators

Oleg’s original IterateeM.hs includes some basic iteratees for parsing, so this section ports them to the new interface. However, in practice most parsing will be performed with enumerator-based interfaces to existing parser libraries (such as Parsec or Attoparsec).

head :: Monad m => Iteratee a m (Maybe a)Source

peek :: Monad m => Iteratee a m (Maybe a)Source

last :: Monad m => Iteratee a m (Maybe a)Source

length :: Monad m => Iteratee a m IntegerSource

drop :: Monad m => Integer -> Iteratee a m ()Source

dropWhile :: Monad m => (a -> Bool) -> Iteratee a m ()Source

span :: Monad m => (a -> Bool) -> Iteratee a m [a]Source

break :: Monad m => (a -> Bool) -> Iteratee a m [a]Source

break p = span (not . p)