pipes-3.2.0: Compositional pipelines

Safe HaskellSafe-Inferred

Control.Proxy.Class

Contents

Description

The Proxy class defines the library's core API. Everything else in this library builds on top of the Proxy type class so that all proxy implementations and extensions can share the same standard library.

Synopsis

Core proxy class

class ProxyInternal p => Proxy p whereSource

The core API for the pipes library

Methods

request :: Monad m => a' -> p a' a b' b m aSource

request input from upstream, passing an argument with the request

request a' passes a' as a parameter to upstream that upstream may use to decide what response to return. request binds the upstream's response of type a to its own return value.

respond :: Monad m => b -> p a' a b' b m b'Source

respond with an output for downstream and bind downstream's next request

respond b satisfies a downstream request by supplying the value b. respond blocks until downstream requests a new value and binds the argument of type b' from the next request as its return value.

(->>) :: Monad m => (b' -> p a' a b' b m r) -> p b' b c' c m r -> p a' a c' c m rSource

Connect an upstream Proxy that handles all requests

Point-ful version of (>->)

(>>~) :: Monad m => p a' a b' b m r -> (b -> p b' b c' c m r) -> p a' a c' c m rSource

Connect a downstream Proxy that handles all responds

Point-ful version of (>~>)

Instances

Proxy ProxyFast 
Proxy ProxyCorrect 
Proxy p => Proxy (MaybeP p) 
Proxy p => Proxy (IdentityP p) 
Proxy p => Proxy (CodensityP p) 
Proxy p => Proxy (EitherP e p) 
Proxy p => Proxy (StateP s p) 
Proxy p => Proxy (WriterP w p) 
Proxy p => Proxy (ReaderP i p) 

(>->) :: (Monad m, Proxy p) => (b' -> p a' a b' b m r) -> (c'_ -> p b' b c' c m r) -> c'_ -> p a' a c' c m rSource

Pull-based composition

Compose two proxies blocked on a respond, generating a new proxy blocked on a respond. Begins from the downstream end and satisfies every request with a respond.

idT :: (Monad m, Proxy p) => a' -> p a' a a' a m rSource

Pull-based identity

idT forwards requests followed by responses 

 idT = request >=> respond >=> idT

(>~>) :: (Monad m, Proxy p) => (a_ -> p a' a b' b m r) -> (b -> p b' b c' c m r) -> a_ -> p a' a c' c m rSource

Push-based composition

Compose two proxies blocked on a request, generating a new proxy blocked on a request. Begins from the upstream end and satisfies every respond with a request

coidT :: (Monad m, Proxy p) => a -> p a' a a' a m rSource

Push-based identity

coidT forwards responses followed by requests 

 coidT = respond >=> request >=> coidT

Flipped operators

(<-<) :: (Monad m, Proxy p) => (c' -> p b' b c' c m r) -> (b' -> p a' a b' b m r) -> c' -> p a' a c' c m rSource

Equivalent to (>->) with the arguments flipped

(<~<) :: (Monad m, Proxy p) => (b -> p b' b c' c m r) -> (a -> p a' a b' b m r) -> a -> p a' a c' c m rSource

Equivalent to (>~>) with the arguments flipped

(<<-) :: (Monad m, Proxy p) => p b' b c' c m r -> (b' -> p a' a b' b m r) -> p a' a c' c m rSource

Equivalent to (->>) with the arguments flipped

(~<<) :: (Monad m, Proxy p) => (b -> p b' b c' c m r) -> p a' a b' b m r -> p a' a c' c m rSource

Equivalent to (>>~) with the arguments flipped

Laws

The Proxy class defines an interface to all core proxy capabilities that all proxy-like types must implement.

First, all proxies must support a bidirectional flow of information, defined by:

Intuitively, both p1 >-> p2 and p1 >~> p2 pair each request in p2 with a respond in p1. (>->) accepts proxies blocked on respond and begins from the downstream end, whereas (>~>) accepts proxies blocked on request and begins from the upstream end.

Second, all proxies are monads and must satify the monad laws using (>>=) = (?>=) and return = return_P.

Third, all proxies are monad transformers and must satisfy the monad transformer laws, using lift = lift_P.

Fourth, all proxies are functors in the category of monads and must satisfy the functor laws, using hoist = hoist_P.

Fifth, all proxies form two streaming categories:

  • (>->) and idT form the "pull-based" category: 
 Define: idT = request >=> respond >=> idT
 Define: k1 >-> k2 = \c' -> k1 ->> k2 c'

 idT >-> p = p

 p >-> idT = p

 (p1 >-> p2) >-> p3 = p1 >-> (p2 >-> p3)
  • (>~>) and coidT form the "push-based" category: 
 Define: coidT = respond >=> request >=> coidT
 Define: k1 >~> k2 = \a -> k1 a >>~ k2

 coidT >~> p = p

 p >~> coidT = p

 (p1 >~> p2) >~> p3 = p1 >~> (p2 >~> p3)

Also, all proxies must satisfy the following Proxy laws: 

 -- Define: liftK = (lift .)

 p1 >-> liftK f = liftK f

 p1 >-> (liftK f >=> respond >=> p2) = liftK f >=> respond >=> (p1 >-> p2)

 (liftK g >=> respond >=> p1) >-> (liftK f >=> request >=> liftK h >=> p2)
     = liftK (f >=> g >=> h) >=> (p1 >-> p2)

 (liftK g >=> request >=> p1) >-> (liftK f >=> request >=> p2)
     = liftK (f >=> g) >=> request >=> (p1 >~> p2)

 liftK f >~> p2 = liftK f

 (liftK f >=> request >=> p1) >~> p2 = liftK f >=> request >=> (p1 >~> p2)

 (liftK f >=> respond >=> liftK h >=> p1) >~> (liftK g >=> request >=> p2)
     = liftK (f >=> g >=> h) >=> (p1 >~> p2)

 (liftK f >=> respond >=> p1) >~> (liftK g >=> respond >=> p2)
     = liftK (f >=> g) >=> (p1 >-> p2)

Polymorphic proxies

The ProxyInternal and MonadPlusP type classes duplicate methods from more familiar type classes. These duplicate methods serve two purposes.

First, this library requires type class instances that would otherwise be impossible to define without providing higher-kinded constraints. Rather than use the following illegal polymorphic constraint: 

 instance (forall a' a b' b . MonadTrans (p a' a b' b)) => ...

... the instance can instead use the following Haskell98 constraint: 

 instance (Proxy p) => ...

Second, these type classes don't require the FlexibleContexts extension to use and substantially clean up constraints in type signatures. They convert messy constraints like this: 

 p :: (MonadP (p a' a b' b m), MonadTrans (p a' a b' b)) => ...

.. into cleaner and more general constraints like this: 

 p :: (Proxy p) => ...

ProxyInternal and MonadPlusP exist solely for internal type class plumbing and I discourage you from using the methods in these classes unless you enjoy making your code less readable. Instead, you can use all the original type classes as long as you embed your proxy code within at least one proxy transformer (or IdentityP if don't use any transformers). The type-class machinery will then automatically convert the messier and less polymorphic constraints to the simpler and more general constraints.

For example, consider the following almost-correct definition for mapMD (from Control.Proxy.Prelude.Base): 

 import Control.Monad.Trans.Class
 import Control.Proxy

 mapMD f = foreverK $ \a' -> do
     a <- request a'
     b <- lift (f a)
     respond b

The compiler infers the following messy constraint: 

 mapMD
  :: (Monad m, Monad (p x a x b m), MonadTrans (p x a x b), Proxy p)
  => (a -> m b) -> x -> p x a x b m r

Instead, you can embed the code in the IdentityP proxy transformer by wrapping it in runIdentityK: 

 --        |difference|  
 mapMD f = runIdentityK $ foreverK $ \a' -> do
     a <- request a'
     b <- lift (f a)
     respond b

... and now the compiler collapses all the constraints into the Proxy constraint: 

 mapMD :: (Monad m, Proxy p) => (a -> m b) -> x -> p x a x b m r

You do not incur any performance penalty for writing polymorphic code or embedding it in IdentityP. This library employs several rewrite RULES which transform your polymorphic code into the equivalent type-specialized hand-tuned code. These rewrite rules fire very robustly and they do not require any assistance on your part from compiler pragmas like INLINE, NOINLINE or SPECIALIZE.

If you nest proxies within proxies: 

 example () = do
     request ()
     lift $ request ()
     lift $ lift $ request ()

... then you can still keep the nice constraints using: 

 example () = runIdentityP . hoist (runIdentityP . hoist runIdentityP) $ do
     request ()
     lift $ request ()
     lift $ lift $ request ()

You don't need to use runIdentityP / runIdentityK if you use any other proxy transformers (In fact you can't, it's a type error). The following code example illustrates this, where the throw command (from the EitherP proxy transformer) suffices to guide the compiler to the cleaner type signature: 

 import Control.Monad
 import Control.Proxy
 import qualified Control.Proxy.Trans.Either as E

 example :: (Monad m, Proxy p) => () -> Producer (EitherP String p) Char m ()
 example () = do
     c <- request ()
     when (c == ' ') $ E.throw "Error: received space"
     respond c

class ProxyInternal p whereSource

The (ProxyInternal p) constraint is (basically) equivalent to the following polymorphic constraint: 

 (forall a' a b' b m . (Monad m)
     => Monad      (p a' a b' b m)
     ,  MonadTrans (p a' a b' b  )
     ,  MFunctor   (p a' a b' b m)
     ,  MonadIO    (p a' a b' b m)
     ) => ...

Methods

return_P :: Monad m => r -> p a' a b' b m rSource

(?>=) :: Monad m => p a' a b' b m r -> (r -> p a' a b' b m r') -> p a' a b' b m r'Source

lift_P :: Monad m => m r -> p a' a b' b m rSource

hoist_P :: Monad m => (forall r. m r -> n r) -> p a' a b' b m r' -> p a' a b' b n r'Source

liftIO_P :: MonadIO m => IO r -> p a' a b' b m rSource

Instances

class Proxy p => MonadPlusP p whereSource

The (MonadPlusP p) constraint is equivalent to the following polymorphic constraint: 

 (forall a' a b' b m . (Monad m) => MonadPlus (p a' a b' b m)) => ...

Methods

mzero_P :: Monad m => p a' a b' b m rSource

mplus_P :: Monad m => p a' a b' b m r -> p a' a b' b m r -> p a' a b' b m rSource

Instances