chan-split 0.1.3 → 0.2.0

raw patch · 4 files changed

+58/−45 lines, 4 filesdep +cofunctorPVP ok

version bump matches the API change (PVP)

Dependencies added: cofunctor

API changes (from Hackage documentation)

Files

• Control/Concurrent/Chan/Class.hs +25/−17
• Control/Concurrent/Chan/Split.hs +10/−13
• Data/Cofunctor.lhs +0/−10
• chan-split.cabal +23/−5

@@ -1,3 +1,4 @@+{-# LANGUAGE MultiParamTypeClasses, FunctionalDependencies #-} module Control.Concurrent.Chan.Class     where @@ -13,22 +14,26 @@ -}  --- | A class for Chan types that can be written to. A minimum complete--- instance defines one of 'writeList2Chan' or 'writeChan'-class WritableChan c where+-- | A class for chan types with a \"write end\" and a \"read end\". A minimal+-- complete instance defines 'readChan' and one of 'writeChan' or+-- 'writeList2Chan'.+class SplitChan i o | i -> o, o -> i where+    -- | Read the next value from the 'OutChan'.+    readChan :: o a -> IO a+     -- | Write an entire list of items to a chan type-    writeList2Chan :: c a -> [a] -> IO ()+    writeList2Chan :: i a -> [a] -> IO ()     writeList2Chan = mapM_ . writeChan      -- | Write a value to a Chan type.-    writeChan :: c a -> a -> IO ()+    writeChan :: i a -> a -> IO ()     writeChan c = writeList2Chan c . return --- | A class for Chan types that can be read from. -class ReadableChan c where-    -- | Read the next value from the 'OutChan'.-    readChan :: c a -> IO a-+-- | A class for 'SplitChan' types that can be instantiated without programmer+-- input. /e.g./ the standard haskell @Chan@ is a member of this class, however+-- a bounded chan type that took an @Int@ to define the buffer size would not.+class (SplitChan i o)=> NewSplitChan i o where+    newSplitChan :: IO (i a, o a)   -- -------------------------------@@ -36,17 +41,20 @@ -- -------------------------------  -instance WritableChan C.Chan where+instance SplitChan C.Chan C.Chan where     writeList2Chan = C.writeList2Chan     writeChan = C.writeChan--instance ReadableChan C.Chan where     readChan = C.readChan +instance NewSplitChan C.Chan C.Chan where+    newSplitChan = do c <- C.newChan+                      return (c,c) --- an MVar is a bounded Singleton Chan. Think about it.-instance WritableChan MVar where+-- an MVar is a singly-bounded Chan. Think about it.+instance SplitChan MVar MVar where     writeChan = putMVar--instance ReadableChan MVar where     readChan = takeMVar+       +instance NewSplitChan MVar MVar where+    newSplitChan = do v <- newEmptyMVar+                      return (v,v)

@@ -1,8 +1,7 @@-{-# LANGUAGE GADTs #-}+{-# LANGUAGE GADTs, MultiParamTypeClasses #-} module Control.Concurrent.Chan.Split (     -- * Chan pairs-      newSplitChan-    , InChan()+      InChan()     , OutChan()     -- * Utility functions:     , getChanContents@@ -16,9 +15,10 @@ import Data.Cofunctor import Control.Applicative import Control.Arrow--- provided by chan-split: import Control.Concurrent.Chan.Class ++ -- TODO: test performance of this with and without fmaped / cofmaped values in -- comparison with standard Chan. Test to see if we can improve performance -- using special constructor for fmaped / cofmaped version@@ -32,18 +32,15 @@ data OutChan o where     OutChan :: (a -> o) -> C.Chan a -> OutChan o --- | Create corresponding read and write ends of a chan pair. Writes to the--- 'InChan' side can be read on the 'OutChan' side.-newSplitChan :: IO (InChan a, OutChan a)-newSplitChan = (InChan id &&& OutChan id) <$> C.newChan-+instance NewSplitChan InChan OutChan where+    -- | Create corresponding read and write ends of a chan pair. Writes to the+    -- 'InChan' side can be read on the 'OutChan' side.+    newSplitChan = (InChan id &&& OutChan id) <$> C.newChan  -instance WritableChan InChan where+instance SplitChan InChan OutChan where     writeChan (InChan f c) = C.writeChan c . f     writeList2Chan (InChan f c) = C.writeList2Chan c . map f--instance ReadableChan OutChan where     readChan (OutChan f c) = f <$> C.readChan c   instance Cofunctor InChan where@@ -74,5 +71,5 @@ mergeOutChans cs =      as <- mapM C.getChanContents cs     ...-    -}+-} 

@@ -1,10 +0,0 @@-> module Data.Cofunctor (->     Cofunctor(..)->     ) where---This doesn't seem to be a popular class, unfortunately but it's useful for us-here: it lets us transform a Mailbox/sink/processor of one input type to another--> class Cofunctor f where->     cofmap :: (b -> a) -> f a -> f b

@@ -8,7 +8,7 @@ -- The package version. See the Haskell package versioning policy -- (http://www.haskell.org/haskellwiki/Package_versioning_policy) for -- standards guiding when and how versions should be incremented.-Version:             0.1.3+Version:             0.2.0  -- A short (one-line) description of the package. Synopsis:            Concurrent Chans as read/write pairs. Also provides generic@@ -41,8 +41,22 @@                      Note, we do not implement the deprecated unGetChan and                       isEmptyChan functions.                      .-                     This module is used internally by the simple-actors package.+                     This module is used internally by the "simple-actors" package.+                     .+                     /CHANGES/:+                     0.1.3 -> 0.2.0   +                        - moved @Data.Cofunctor@ to its own module "cofunctor"++                        - redefine chan pair classes using fundeps+                          to express the relationship between input+                          and output halfs of a Chan++                        - define 'NewSplitChan' class for chan pairs that can be+                          instantiated+                     . ++ -- The license under which the package is released. License:             BSD3 @@ -76,13 +90,17 @@   Library-  -- Modules exported by the library.+                     -- for the split chan class:+  Extensions:          MultiParamTypeClasses+                     , FunctionalDependencies +                     -- for Functor / Cofunctor instances:+                     , GADTs+   Exposed-modules:     Control.Concurrent.Chan.Split                      , Control.Concurrent.Chan.Class-                     , Data.Cofunctor   -  -- Packages needed in order to build this package.   Build-depends:       base >= 4 && < 5+                     , cofunctor      ghc-options:        -Wall