Copyright	(c) Riley Evans 2020
License	BSD 3-Clause
Maintainer	haskell@rly.rocks
Safe Haskell	None
Language	Haskell2010

Pipeline.Task

Contents

Creating a Task
Smart Constructors
Misc

Description

Contains the tools needed to create, interact with and stop a network.

Synopsis

task :: (DataStore' fs as, DataStore g b, Eq (g b)) => (HList' fs as -> g b -> ExceptT SomeException IO ()) -> Circuit fs as '[g] '[b] (Length fs)
multiInputTask :: (DataStore' fs as, DataStore g b, Eq (g b), NFData b) => (HList as -> b) -> Circuit fs as '[g] '[b] (Length fs)
functionTask :: (DataStore f a, DataStore g b, Eq (g b), Eq a, Eq (f a), NFData b) => (a -> b) -> Circuit '[f] '[a] '[g] '[b] ('Succ 'Zero)
data HList (xs :: [Type]) where
- HCons :: Eq x => x -> HList xs -> HList (x ': xs)
- HNil :: HList '[]
data HList' (fs :: [Type -> Type]) (as :: [Type]) where
- HCons' :: Eq (f a) => f a -> HList' fs as -> HList' (f ': fs) (a ': as)
- HNil' :: HList' '[] '[]
data ExceptT e (m :: Type -> Type) a

Creating a Task

A Task, is one of the key components of this system. They will be converted into threads in the process network.

The function a Task executes has a specific type and a task will need to do multiple things.

The first agument will be a HList' containing all the DataStores, to be fetched from. The second argument is the "empty" DataStores or "pointers" to a storage location, where the result should be saved.

A task should:

use fetch' to retrieve all the inputs from the DataStores.
use save' to save the outputs to the DataStores, this should take the second argument given to the Task.

task #

Arguments

:: (DataStore' fs as, DataStore g b, Eq (g b))
=> (HList' fs as -> g b -> ExceptT SomeException IO ())	The function a Task will execute.
-> Circuit fs as '[g] '[b] (Length fs)

Constructor for a task

Smart Constructors

multiInputTask #

Arguments

:: (DataStore' fs as, DataStore g b, Eq (g b), NFData b)
=> (HList as -> b)	The function to execute
-> Circuit fs as '[g] '[b] (Length fs)

This allows a function with multiple inputs to be converted into a Task.

functionTask #

Arguments

:: (DataStore f a, DataStore g b, Eq (g b), Eq a, Eq (f a), NFData b)
=> (a -> b)	The function to execute
-> Circuit '[f] '[a] '[g] '[b] ('Succ 'Zero)

This allows a single a -> b to be converted into a Task.

Misc

data HList (xs :: [Type]) where #

A heterogeneous list used as input/output to a task.

This is commonly used in the multiInputTask function, which automatically fetches the data from DataStore.

Constructors

HCons :: Eq x => x -> HList xs -> HList (x ': xs)
HNil :: HList '[]

Instances

Instances details

Eq (HList as) #
Instance details Defined in Pipeline.Internal.Common.HList Methods (==) :: HList as -> HList as -> Bool # (/=) :: HList as -> HList as -> Bool #

data HList' (fs :: [Type -> Type]) (as :: [Type]) where #

A heterogeneous list used as input/output to a network or task.

Constructors

HCons' :: Eq (f a) => f a -> HList' fs as -> HList' (f ': fs) (a ': as)
HNil' :: HList' '[] '[]

Instances

Instances details

Eq (HList' fs as) #
Instance details Defined in Pipeline.Internal.Common.HList Methods (==) :: HList' fs as -> HList' fs as -> Bool # (/=) :: HList' fs as -> HList' fs as -> Bool #

data ExceptT e (m :: Type -> Type) a #

A monad transformer that adds exceptions to other monads.

ExceptT constructs a monad parameterized over two things:

e - The exception type.
m - The inner monad.

The return function yields a computation that produces the given value, while >>= sequences two subcomputations, exiting on the first exception.

Instances

Instances details

MonadBaseControl b m => MonadBaseControl b (ExceptT e m)
Instance details Defined in Control.Monad.Trans.Control Associated Types type StM (ExceptT e m) a Methods liftBaseWith :: (RunInBase (ExceptT e m) b -> b a) -> ExceptT e m a restoreM :: StM (ExceptT e m) a -> ExceptT e m a
MonadTrans (ExceptT e)
Instance details Defined in Control.Monad.Trans.Except Methods lift :: Monad m => m a -> ExceptT e m a #
MonadTransControl (ExceptT e)
Instance details Defined in Control.Monad.Trans.Control Associated Types type StT (ExceptT e) a Methods liftWith :: Monad m => (Run (ExceptT e) -> m a) -> ExceptT e m a restoreT :: Monad m => m (StT (ExceptT e) a) -> ExceptT e m a
Monad m => Monad (ExceptT e m)
Instance details Defined in Control.Monad.Trans.Except Methods (>>=) :: ExceptT e m a -> (a -> ExceptT e m b) -> ExceptT e m b # (>>) :: ExceptT e m a -> ExceptT e m b -> ExceptT e m b # return :: a -> ExceptT e m a #
Functor m => Functor (ExceptT e m)
Instance details Defined in Control.Monad.Trans.Except Methods fmap :: (a -> b) -> ExceptT e m a -> ExceptT e m b # (<$) :: a -> ExceptT e m b -> ExceptT e m a #
MonadFix m => MonadFix (ExceptT e m)
Instance details Defined in Control.Monad.Trans.Except Methods mfix :: (a -> ExceptT e m a) -> ExceptT e m a #
MonadFail m => MonadFail (ExceptT e m)
Instance details Defined in Control.Monad.Trans.Except Methods fail :: String -> ExceptT e m a #
(Functor m, Monad m) => Applicative (ExceptT e m)
Instance details Defined in Control.Monad.Trans.Except Methods pure :: a -> ExceptT e m a # (<>) :: ExceptT e m (a -> b) -> ExceptT e m a -> ExceptT e m b # liftA2 :: (a -> b -> c) -> ExceptT e m a -> ExceptT e m b -> ExceptT e m c # (>) :: ExceptT e m a -> ExceptT e m b -> ExceptT e m b # (<*) :: ExceptT e m a -> ExceptT e m b -> ExceptT e m a #
Foldable f => Foldable (ExceptT e f)
Instance details Defined in Control.Monad.Trans.Except Methods fold :: Monoid m => ExceptT e f m -> m # foldMap :: Monoid m => (a -> m) -> ExceptT e f a -> m # foldMap' :: Monoid m => (a -> m) -> ExceptT e f a -> m # foldr :: (a -> b -> b) -> b -> ExceptT e f a -> b # foldr' :: (a -> b -> b) -> b -> ExceptT e f a -> b # foldl :: (b -> a -> b) -> b -> ExceptT e f a -> b # foldl' :: (b -> a -> b) -> b -> ExceptT e f a -> b # foldr1 :: (a -> a -> a) -> ExceptT e f a -> a # foldl1 :: (a -> a -> a) -> ExceptT e f a -> a # toList :: ExceptT e f a -> [a] # null :: ExceptT e f a -> Bool # length :: ExceptT e f a -> Int # elem :: Eq a => a -> ExceptT e f a -> Bool # maximum :: Ord a => ExceptT e f a -> a # minimum :: Ord a => ExceptT e f a -> a # sum :: Num a => ExceptT e f a -> a # product :: Num a => ExceptT e f a -> a #
Traversable f => Traversable (ExceptT e f)
Instance details Defined in Control.Monad.Trans.Except Methods traverse :: Applicative f0 => (a -> f0 b) -> ExceptT e f a -> f0 (ExceptT e f b) # sequenceA :: Applicative f0 => ExceptT e f (f0 a) -> f0 (ExceptT e f a) # mapM :: Monad m => (a -> m b) -> ExceptT e f a -> m (ExceptT e f b) # sequence :: Monad m => ExceptT e f (m a) -> m (ExceptT e f a) #
Contravariant m => Contravariant (ExceptT e m)
Instance details Defined in Control.Monad.Trans.Except Methods contramap :: (a -> b) -> ExceptT e m b -> ExceptT e m a # (>$) :: b -> ExceptT e m b -> ExceptT e m a #
(Eq e, Eq1 m) => Eq1 (ExceptT e m)
Instance details Defined in Control.Monad.Trans.Except Methods liftEq :: (a -> b -> Bool) -> ExceptT e m a -> ExceptT e m b -> Bool #
(Ord e, Ord1 m) => Ord1 (ExceptT e m)
Instance details Defined in Control.Monad.Trans.Except Methods liftCompare :: (a -> b -> Ordering) -> ExceptT e m a -> ExceptT e m b -> Ordering #
(Read e, Read1 m) => Read1 (ExceptT e m)
Instance details Defined in Control.Monad.Trans.Except Methods liftReadsPrec :: (Int -> ReadS a) -> ReadS [a] -> Int -> ReadS (ExceptT e m a) # liftReadList :: (Int -> ReadS a) -> ReadS [a] -> ReadS [ExceptT e m a] # liftReadPrec :: ReadPrec a -> ReadPrec [a] -> ReadPrec (ExceptT e m a) # liftReadListPrec :: ReadPrec a -> ReadPrec [a] -> ReadPrec [ExceptT e m a] #
(Show e, Show1 m) => Show1 (ExceptT e m)
Instance details Defined in Control.Monad.Trans.Except Methods liftShowsPrec :: (Int -> a -> ShowS) -> ([a] -> ShowS) -> Int -> ExceptT e m a -> ShowS # liftShowList :: (Int -> a -> ShowS) -> ([a] -> ShowS) -> [ExceptT e m a] -> ShowS #
MonadZip m => MonadZip (ExceptT e m)
Instance details Defined in Control.Monad.Trans.Except Methods mzip :: ExceptT e m a -> ExceptT e m b -> ExceptT e m (a, b) # mzipWith :: (a -> b -> c) -> ExceptT e m a -> ExceptT e m b -> ExceptT e m c # munzip :: ExceptT e m (a, b) -> (ExceptT e m a, ExceptT e m b) #
MonadIO m => MonadIO (ExceptT e m)
Instance details Defined in Control.Monad.Trans.Except Methods liftIO :: IO a -> ExceptT e m a #
(Functor m, Monad m, Monoid e) => Alternative (ExceptT e m)
Instance details Defined in Control.Monad.Trans.Except Methods empty :: ExceptT e m a # (<\|>) :: ExceptT e m a -> ExceptT e m a -> ExceptT e m a # some :: ExceptT e m a -> ExceptT e m [a] # many :: ExceptT e m a -> ExceptT e m [a] #
(Monad m, Monoid e) => MonadPlus (ExceptT e m)
Instance details Defined in Control.Monad.Trans.Except Methods mzero :: ExceptT e m a # mplus :: ExceptT e m a -> ExceptT e m a -> ExceptT e m a #
PrimMonad m => PrimMonad (ExceptT e m)
Instance details Defined in Control.Monad.Primitive Associated Types type PrimState (ExceptT e m) Methods primitive :: (State# (PrimState (ExceptT e m)) -> (# State# (PrimState (ExceptT e m)), a #)) -> ExceptT e m a
(Eq e, Eq1 m, Eq a) => Eq (ExceptT e m a)
Instance details Defined in Control.Monad.Trans.Except Methods (==) :: ExceptT e m a -> ExceptT e m a -> Bool # (/=) :: ExceptT e m a -> ExceptT e m a -> Bool #
(Ord e, Ord1 m, Ord a) => Ord (ExceptT e m a)
Instance details Defined in Control.Monad.Trans.Except Methods compare :: ExceptT e m a -> ExceptT e m a -> Ordering # (<) :: ExceptT e m a -> ExceptT e m a -> Bool # (<=) :: ExceptT e m a -> ExceptT e m a -> Bool # (>) :: ExceptT e m a -> ExceptT e m a -> Bool # (>=) :: ExceptT e m a -> ExceptT e m a -> Bool # max :: ExceptT e m a -> ExceptT e m a -> ExceptT e m a # min :: ExceptT e m a -> ExceptT e m a -> ExceptT e m a #
(Read e, Read1 m, Read a) => Read (ExceptT e m a)
Instance details Defined in Control.Monad.Trans.Except Methods readsPrec :: Int -> ReadS (ExceptT e m a) # readList :: ReadS [ExceptT e m a] # readPrec :: ReadPrec (ExceptT e m a) # readListPrec :: ReadPrec [ExceptT e m a] #
(Show e, Show1 m, Show a) => Show (ExceptT e m a)
Instance details Defined in Control.Monad.Trans.Except Methods showsPrec :: Int -> ExceptT e m a -> ShowS # show :: ExceptT e m a -> String # showList :: [ExceptT e m a] -> ShowS #
type StT (ExceptT e) a
Instance details Defined in Control.Monad.Trans.Control type StT (ExceptT e) a = Either e a
type PrimState (ExceptT e m)
Instance details Defined in Control.Monad.Primitive type PrimState (ExceptT e m) = PrimState m
type StM (ExceptT e m) a
Instance details Defined in Control.Monad.Trans.Control type StM (ExceptT e m) a = ComposeSt (ExceptT e) m a