Control.Funflow

Central Funflow module.

This module just re-exports various other modules for convenience.

Documentation

type Flow eff ex = ErrorChoice ex (Flow' eff)

type SimpleFlow = Flow NoEffect SomeException

type (==>) = SimpleFlow

data NoEffect a b

data Flow' eff a b where

Constructors

Step :: Properties a b -> (a -> b) -> Flow' eff a b

StepIO :: Properties a b -> (a -> IO b) -> Flow' eff a b

External :: ExternalProperties a -> (a -> ExternalTask) -> Flow' eff a Item

PutInStore :: ContentHashable IO a => (Path Abs Dir -> a -> IO ()) -> Flow' eff a Item

GetFromStore :: (Path Abs t -> IO a) -> Flow' eff (Content t) a

InternalManipulateStore :: (ContentStore -> a -> IO b) -> Flow' eff a b

Wrapped :: Properties a b -> eff a b -> Flow' eff a b

Instances

ArrowFlow eff ex (Flow eff ex)

Defined in Control.Funflow.Class

Methods

step' :: Properties a b -> (a -> b) -> Flow eff ex a b

stepIO' :: Properties a b -> (a -> IO b) -> Flow eff ex a b

external :: (a -> ExternalTask) -> Flow eff ex a Item

external' :: ExternalProperties a -> (a -> ExternalTask) -> Flow eff ex a Item

wrap' :: Properties a b -> eff a b -> Flow eff ex a b

putInStore :: ContentHashable IO a => (Path Abs Dir -> a -> IO ()) -> Flow eff ex a Item

getFromStore :: (Path Abs t -> IO a) -> Flow eff ex (Content t) a

internalManipulateStore :: (ContentStore -> a -> IO b) -> Flow eff ex a b

data Cacher i o

A cacher is responsible for controlling how steps are cached.

Constructors

NoCache

This step cannot be cached (default).

Cache

Fields

• cacherKey :: Int -> i -> ContentHash

  Function to encode the input into a content hash. This function additionally takes an identities which gets incorporated into the cacher.

• cacherStoreValue :: o -> ByteString
• cacherReadValue :: ByteString -> o

  Attempt to read the cache value back. May throw exceptions.

data ExternalProperties a

Additional properties associated with external tasks.

Constructors

ExternalProperties

Fields

• ep_mdpolicy :: MDWriter a ()

  Write additional metadata to the content store.

• ep_impure :: Bool

  Specify that this external step is impure, and as such should not be cached.

Instances

Default (ExternalProperties a)

Defined in Control.Funflow.Base

Methods

def :: ExternalProperties a

type MDWriter i o = Maybe (i -> o -> [(Text, ByteString)])

Metadata writer

data Properties i o

Constructors

Properties

Fields

• name :: Maybe Text

  Name of this step. Used when describing the step in diagrams or other reporting.

• cache :: Cacher i o

  Specify whether this step can be cached or not and, if so, how to do so.

• mdpolicy :: MDWriter i o

  Write additional metadata to the content store.

Instances

Default (Properties i o)

Defined in Control.Funflow.Base

Methods

def :: Properties i o

defaultCacherWithIdent

Arguments

:: (Store o, ContentHashable Identity i)

=> Int

Seed for the cacher

-> Cacher i o

defaultCacher :: Q Exp

Create a default cacher with a random identity.

Note that this cacher is deliberately conservative - e.g. if the application is recompiled, the cache will not be reused.

defaultCacherLoc

Arguments

:: Int

Version

-> Q Exp

Create a default cacher based on the location of this splice. Note that this may lead to invalid cacheing if the code is changed without the version being updated.

Defines our primitive flow functions

class (ArrowChoice arr, ArrowError ex arr) => ArrowFlow eff ex arr | arr -> eff ex where

Minimal complete definition

step', stepIO', external, external', wrap', putInStore, getFromStore, internalManipulateStore

Methods

step' :: Properties a b -> (a -> b) -> arr a b

Create a flow from a pure function.

stepIO' :: Properties a b -> (a -> IO b) -> arr a b

Create a flow from an IO action.

external :: (a -> ExternalTask) -> arr a Item

Create an external task in the flow.

external' :: ExternalProperties a -> (a -> ExternalTask) -> arr a Item

Create an external task with additional properties

wrap' :: Properties a b -> eff a b -> arr a b

Create a flow from a user-defined effect.

putInStore :: ContentHashable IO a => (Path Abs Dir -> a -> IO ()) -> arr a Item

Create a flow which will write its incoming data to the store.

getFromStore :: (Path Abs t -> IO a) -> arr (Content t) a

Create a flow which will read data from the given store item.

internalManipulateStore :: (ContentStore -> a -> IO b) -> arr a b

Perform some internal manipulation of the content store.

Instances

ArrowFlow eff ex (Flow eff ex)

Defined in Control.Funflow.Class

Methods

step' :: Properties a b -> (a -> b) -> Flow eff ex a b

stepIO' :: Properties a b -> (a -> IO b) -> Flow eff ex a b

external :: (a -> ExternalTask) -> Flow eff ex a Item

external' :: ExternalProperties a -> (a -> ExternalTask) -> Flow eff ex a Item

wrap' :: Properties a b -> eff a b -> Flow eff ex a b

putInStore :: ContentHashable IO a => (Path Abs Dir -> a -> IO ()) -> Flow eff ex a Item

getFromStore :: (Path Abs t -> IO a) -> Flow eff ex (Content t) a

internalManipulateStore :: (ContentStore -> a -> IO b) -> Flow eff ex a b

step :: ArrowFlow eff ex arr => (a -> b) -> arr a b

Create a flow from a pure function. This is a variant on step' which uses the default properties.

stepIO :: ArrowFlow eff ex arr => (a -> IO b) -> arr a b

Create a flow from an IO action. This is a variant on stepIO' which uses the default properties.

wrap :: ArrowFlow eff ex arr => eff a b -> arr a b

withStore :: (MonadIO m, MonadMask m) => Path Abs Dir -> (ContentStore -> m a) -> m a

Open the store under the given root and perform the given action. Closes the store once the action is complete

See also: open

module Control.Funflow.Steps

module Control.Funflow.Exec.Simple

module Control.Funflow.External