Next.Consumer

Types

See Next.Consumer.Type

type Consumer action item product = Job (Next item) action product

A Job whose upstream interface is Next

type ConsumerPlus up action item product = TerminableStream item up => Job up action product

Like Consumer, but with a more general upstream interface which can be anything in the TerminableStream class

This type is like Consumer except that it has an extra type parameter representing the upstream interface, hence its name is "consumer plus".

Examples

See Next.Consumer.Examples

foldPure :: Fold item product -> ConsumerPlus up action item product

Run the stream completely, collecting results using a pure fold

See Fold.Pure

foldEffect :: EffectfulFold action item product -> ConsumerPlus up action item product

Run the stream completely, collecting results using an effectful fold

See Fold.Effectful

foldJob :: forall item product action up. EffectfulFold (Job up action) item product -> ConsumerPlus up action item product

Run the stream completely, collecting results using a fold that operates in the Job context

See Fold.Effectful

toList :: forall up action item. ConsumerPlus up action item [item]

Consumes all items and returns them as a list

run :: forall up action item. ConsumerPlus up action item ()

Like toList, but discards the results