Documentation

A simple processor step with a unit request type and an unspecified response type:

A simple processor with a unit request type, an unspecified response type and a result type tailored towards reporting the terminating condition of an intermediate component in a composed “processor stack”.

A producer version of a simple processor.

A consumer version of a simple processor.

An effect version of a simple processor.

Simple processor result type.

(Just Nothing) Simple processor result value indicating successful processing of the entire input stream.

(Just (Just e)') Simple processor result value indicating unsuccessful processing of the input stream.

(Nothing) Simple processor result value indicating premature termination of the consumer.

Delivers an SPComplete result.

Delivers an SPFailed result.

Delivers an SPIncomplete result.

Consumes an single input value of a simple stream processor.

spfetch represents a singleton simple stream processor that delivers the next input value received, or Nothing if the upstream processor has been depleted.

spemit y represents a singleton stream processor that produces a single output value y, delivering either SPComplete if y was consumed by the downstream processor, or SPIncomplete otherwise.

y >:> p represents a singleton stream processor that produces a single output value y and continues with the processor p, deliverying SPIncomplete if y could not be consumed by the downstream processor.

p >>? q continues processing of p with q but only if p completes successsfully by delivering SPComplete, short-circuiting q if p fails with SPIncomplete or SPFailed.

p >>! k is equivalent to p, with any failures in p supplied to the continuation processor k. Note that k is not executed if p completes successfully with SPComplete or is interrupted by the downstream processor, delivering SPIncomplete.

sppure f produces an infinite consumer/producer that uses a pure function f to convert every input value into an output; equivalent to qpure id f (const ()).

A simple identity processor, equivalent to 'sppure id'.

A simple list flattening processor requests.

A simple processor that filters its input stream.

A processor that delivers the entire input of the stream folded into a single value using mappend.

A processor that delivers the entire input of the stream folded into a single value using strict application of mappend.

A processor that delivers the entire input of the stream folded into a single value using the supplied left-associative function and initial value.

A processor that delivers the entire input of the stream folded into a single value using strict application of the supplied left-associative function and initial value.

A processor that delivers the entire input of the stream folded into a single value using the supplied right-associative function and initial value.

Note that this can be quite inefficient for long streams, since the entire chain of applications of f needs to be materialised on the heap before it can ever be applied to the final value and reduced at the end of the stream.

A processor that applies a monadic function to every input element and emits the resulting value.

A processor that consumes every input elemnet using a monadic function.

Produces every element of a foldable structure.

Produces infinite sequence of monadic results.

Interrupts processing on input that matches a specified predicate.

Interrupts processing on input that doesn't match a specified predicate.

Interrupts processing on a first occurence of Nothing in the input stream.

Evaluates an SEffect, i.e., a simple processor that is both detached and depleted and hence neither consumes nor produces any input, returning its delivered value. The base functor must be a monad.