# pcapriotti/pipes-extra

Update documentation.

1 parent 0017184 commit 689acf405f58ae82c4ff73103ef0c36a0cc16285 committed Feb 6, 2012
Showing with 9 additions and 4 deletions.
1. +7 −2 Control-Pipe-Combinators.html
2. +1 −1 doc-index.html
3. +1 −1 mini_Control-Pipe-Combinators.html
9 Control-Pipe-Combinators.html

pipes-extra-0.0.1: Pipes utilities

Control.Pipe.Combinators

Description

Basic pipe combinators. -

Synopsis

Documentation

(\$\$) :: Monad m => Producer a m r' -> Consumer a m r -> m (Maybe r)

Connect producer to consumer, ignoring producer return value. +

Synopsis

Documentation

(\$\$) :: Monad m => Producer a m r' -> Consumer a m r -> m (Maybe r)

Connect producer to consumer, ignoring producer return value.

fromList :: Monad m => [a] -> Pipe x a m ()

Successively yield elements of a list.

nullP :: Monad m => Pipe a b m ()

A pipe that terminates immediately.

fold :: Monad m => (b -> a -> b) -> b -> Pipe a x m b

A fold pipe. Apply a binary function to successive input values and an @@ -11,7 +11,12 @@

take :: Monad m => Int -> Pipe a a m ()

Act as an identity for the first n values, then terminate.

drop :: Monad m => Int -> Pipe a a m r

Remove the first n values from the stream, then act as an identity.

pipeList :: Monad m => (a -> [b]) -> Pipe a b m r

Apply a function with multiple return values to the stream. -

until :: Monad m => (a -> Bool) -> Pipe a a m ()

Terminate as soon as an input satisfying the predicate is received. +

takeWhile :: Monad m => (a -> Bool) -> Pipe a a m a

Act as an identity until as long as inputs satisfy the given predicate. + Return the first element that doesn't satisfy the predicate. +

takeWhile_ :: Monad m => (a -> Bool) -> Pipe a a m ()

Variation of takeWhile returning (). +

dropWhile :: Monad m => (a -> Bool) -> Pipe a a m r

Remove inputs as long as they satisfy the given predicate, then act as an + identity. +

intersperse :: Monad m => (a -> Bool) -> Pipe a (Maybe a) m r

Yield Nothing when an input satisfying the predicate is received.

groupBy :: Monad m => (a -> a -> Bool) -> Pipe a [a] m r

Group input values by the given predicate.

filter :: Monad m => (a -> Bool) -> Pipe a a m r

Remove values from the stream that don't satisfy the given predicate.

2 doc-index.html
 @@ -1,4 +1,4 @@ pipes-extra-0.0.1: Pipes utilities (Index)

pipes-extra-0.0.1: Pipes utilities

Index

\$\$Control.Pipe.Combinators
ApplicationControl.Pipe.Network
bytesControl.Pipe.Binary
clientHostControl.Pipe.Network
clientPortControl.Pipe.Network
ClientSettings
1 (Type/Class)Control.Pipe.Network
2 (Data Constructor)Control.Pipe.Network
compressControl.Pipe.Zlib
conduitPipeControl.Pipe.Conduit
conduitPipe_Control.Pipe.Conduit
consumeControl.Pipe.Combinators
decompressControl.Pipe.Zlib
dropControl.Pipe.Combinators
dropWhileControl.Pipe.Binary
fileConsumerControl.Pipe.Binary
fileProducerControl.Pipe.Binary
filterControl.Pipe.Combinators
foldControl.Pipe.Combinators
fromListControl.Pipe.Combinators
groupByControl.Pipe.Combinators
gzipControl.Pipe.Zlib
handleConsumerControl.Pipe.Binary
handleIOConsumerControl.Pipe.Binary
handleIOProducerControl.Pipe.Binary
handleProducerControl.Pipe.Binary
isolateControl.Pipe.Binary
linesControl.Pipe.Binary
nullPControl.Pipe.Combinators
pipeListControl.Pipe.Combinators
runTCPClientControl.Pipe.Network
runTCPServerControl.Pipe.Network
serverHostControl.Pipe.Network
serverPortControl.Pipe.Network
ServerSettings
1 (Type/Class)Control.Pipe.Network
2 (Data Constructor)Control.Pipe.Network
sinkPipeControl.Pipe.Conduit
sinkPipe_Control.Pipe.Conduit
sinkSocketControl.Pipe.Network
sourcePipeControl.Pipe.Conduit
sourceSocketControl.Pipe.Network
takeControl.Pipe.Combinators
takeWhileControl.Pipe.Binary
ungzipControl.Pipe.Zlib
untilControl.Pipe.Combinators
+

pipes-extra-0.0.1: Pipes utilities

Index

\$\$Control.Pipe.Combinators
ApplicationControl.Pipe.Network
bytesControl.Pipe.Binary
clientHostControl.Pipe.Network
clientPortControl.Pipe.Network
ClientSettings
1 (Type/Class)Control.Pipe.Network
2 (Data Constructor)Control.Pipe.Network
compressControl.Pipe.Zlib
conduitPipeControl.Pipe.Conduit
conduitPipe_Control.Pipe.Conduit
consumeControl.Pipe.Combinators
decompressControl.Pipe.Zlib
dropControl.Pipe.Combinators
dropWhile
1 (Function)Control.Pipe.Combinators
2 (Function)Control.Pipe.Binary
fileConsumerControl.Pipe.Binary
fileProducerControl.Pipe.Binary
filterControl.Pipe.Combinators
foldControl.Pipe.Combinators
fromListControl.Pipe.Combinators
groupByControl.Pipe.Combinators
gzipControl.Pipe.Zlib
handleConsumerControl.Pipe.Binary
handleIOConsumerControl.Pipe.Binary
handleIOProducerControl.Pipe.Binary
handleProducerControl.Pipe.Binary
intersperseControl.Pipe.Combinators
isolateControl.Pipe.Binary
linesControl.Pipe.Binary
nullPControl.Pipe.Combinators
pipeListControl.Pipe.Combinators
runTCPClientControl.Pipe.Network
runTCPServerControl.Pipe.Network
serverHostControl.Pipe.Network
serverPortControl.Pipe.Network
ServerSettings
1 (Type/Class)Control.Pipe.Network
2 (Data Constructor)Control.Pipe.Network
sinkPipeControl.Pipe.Conduit
sinkPipe_Control.Pipe.Conduit
sinkSocketControl.Pipe.Network
sourcePipeControl.Pipe.Conduit
sourceSocketControl.Pipe.Network
takeControl.Pipe.Combinators
takeWhile
1 (Function)Control.Pipe.Combinators
2 (Function)Control.Pipe.Binary
takeWhile_Control.Pipe.Combinators
ungzipControl.Pipe.Zlib
2 mini_Control-Pipe-Combinators.html
 @@ -1,4 +1,4 @@ Control.Pipe.Combinators

Control.Pipe.Combinators

+

Control.Pipe.Combinators