Modulestreamly-core-0.2.2Haskell2010

Streamly.Internal.Data.Pipe

There are three fundamental types in streamly. They are streams (Streamly.Data.Stream), pipes (Streamly.Internal.Data.Pipe) and folds (Streamly.Data.Fold). Streams are sources or producers of values, multiple sources can be merged into a single source but a source cannot be split into multiple stream sources. Folds are sinks or consumers, a stream can be split and distributed to multiple folds but the results cannot be merged back into a stream source again. Pipes are transformations, a stream source can be split and distributed to multiple pipes each pipe can apply its own transform on the stream and the results can be merged back into a single pipe. Pipes can be attached to a source to produce a source or they can be attached to a fold to produce a fold, or multiple pipes can be merged or zipped into a single pipe.

import qualified Streamly.Internal.Data.Pipe as Pipe

3 types
5 values

Packagestreamly-core-0.2.2
Exports8
LanguageHaskell2010
LicenceBSD-3-Clause
SourcePipe.hs

Pipe Type

7 declarations

datadata Step s a

Constructors

Yield a s
Continue s

valuezipWith

:: Monad m
=> a -> b -> c
-> Pipe m i a
-> Pipe m i b
-> Pipe m i c

The composed pipe distributes the input to both the constituent pipes and zips the output of the two using a supplied zipping function.

valuemap :: Monad m => (a -> b) -> Pipe m a b

Lift a pure function to a Pipe.

datadata Pipe (m :: Type -> Type) a b

Constructors

forall s1 s2. Pipe (s1 -> a -> m (Step (PipeState s1 s2) b)) (s2 -> m (Step (PipeState s1 s2) b)) s1

Instances5Category, Arrow, Functor, Applicative, Semigroup

Monad m => Category (Pipe m)Defined in streamly-core-0.2.2 · Streamly.Internal.Data.Pipe.Type
Monad m => Arrow (Pipe m)Defined in streamly-core-0.2.2 · Streamly.Internal.Data.Pipe.Type
Monad m => Functor (Pipe m a)Defined in streamly-core-0.2.2 · Streamly.Internal.Data.Pipe.Type
Monad m => Applicative (Pipe m a)Defined in streamly-core-0.2.2 · Streamly.Internal.Data.Pipe.Type
Monad m => Semigroup (Pipe m a b)Defined in streamly-core-0.2.2 · Streamly.Internal.Data.Pipe.Type

valuetee :: Monad m => Pipe m a b -> Pipe m a b -> Pipe m a b

The composed pipe distributes the input to both the constituent pipes and merges the outputs of the two.

datadata PipeState s1 s2

Represents a stateful transformation over an input stream of values of type a to outputs of type b in Monad m.

Constructors

Consume s1
Produce s2

valuecompose :: Monad m => Pipe m b c -> Pipe m a b -> Pipe m a c

Compose two pipes such that the output of the second pipe is attached to the input of the first pipe.

Pipes

0 declarations

Mapping

valuemapM :: Monad m => (a -> m b) -> Pipe m a b

Lift a monadic function to a Pipe.