THSH.Funclet

Documentation

class Funclet f where

A funclet is an IO process that communicates through handles and calls back with an exit code.

Minimal complete definition

runFunclet | runFuncletWithHandles

Methods

runFunclet :: f -> (ExitCode -> IO ()) -> IO (Handle, Handle, Handle)

Run the funclet which creates a set of handles itself.

It has a default implementation that calls runFuncletWithHandles with created pipes.

runFuncletWithHandles :: f -> (ExitCode -> IO ()) -> (Handle, Handle, Handle) -> IO ()

Run the funclet with the set of handles provided.

It has a default implementation that simply piping data between runFunclet and the provided handles.

Instances

Funclet AnyFunclet

AnyFunclet is of course also a Funclet.

Defined in THSH.Funclet

Methods

runFunclet :: AnyFunclet -> (ExitCode -> IO ()) -> IO (Handle, Handle, Handle)

runFuncletWithHandles :: AnyFunclet -> (ExitCode -> IO ()) -> (Handle, Handle, Handle) -> IO ()

Funclet Script

The Script instance of Funclet.

Defined in THSH.Script

Methods

runFunclet :: Script -> (ExitCode -> IO ()) -> IO (Handle, Handle, Handle)

runFuncletWithHandles :: Script -> (ExitCode -> IO ()) -> (Handle, Handle, Handle) -> IO ()

FnFunction f => Funclet (Fn f)

The FnFunction instance of Funclet.

Defined in THSH.Fn

Methods

runFunclet :: Fn f -> (ExitCode -> IO ()) -> IO (Handle, Handle, Handle)

runFuncletWithHandles :: Fn f -> (ExitCode -> IO ()) -> (Handle, Handle, Handle) -> IO ()

data AnyFunclet

Existential wrapper of any Funclet.

Constructors

Funclet f => MkAnyFunclet f

Instances

Funclet AnyFunclet

AnyFunclet is of course also a Funclet.

Defined in THSH.Funclet

Methods

runFunclet :: AnyFunclet -> (ExitCode -> IO ()) -> IO (Handle, Handle, Handle)

runFuncletWithHandles :: AnyFunclet -> (ExitCode -> IO ()) -> (Handle, Handle, Handle) -> IO ()

runFuncletWithStdHandles :: Funclet f => f -> IO ExitCode

Run a Funclet with standard handles synchronously.