THSH.Fn

Documentation

class FnFunction f where

A FnFunction is a function that, given a set of handles to communicate with it, it returns an exit code.

Methods

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

Instances

FnFunction (ContentFn IO s)

Defined in THSH.Fn

Methods

runFn :: ContentFn IO s -> (Handle, Handle, Handle) -> IO ExitCode

FnFunction (LineReadFn IO a b)

Defined in THSH.Fn

Methods

runFn :: LineReadFn IO a b -> (Handle, Handle, Handle) -> IO ExitCode

data ContentFn (m :: Type -> Type) s

A FnFunction that converts the entire input content to another as String.

Constructors

MkContentFn (s -> m s) (Handle -> m s) (Handle -> s -> m ())

Instances

FnFunction (ContentFn IO s)

Defined in THSH.Fn

Methods

runFn :: ContentFn IO s -> (Handle, Handle, Handle) -> IO ExitCode

stringContentFn :: (String -> String) -> ContentFn IO String

ContentFn for the String type.

stringContentIOFn :: (String -> IO String) -> ContentFn IO String

IO variant of stringContentFn.

textContentFn :: (Text -> Text) -> ContentFn IO Text

ContentFn for the Text type from the text package.

textContentIOFn :: (Text -> IO Text) -> ContentFn IO Text

IO variant of textContentFn.

data LineReadFn (m :: Type -> Type) a b

A FnFunction that reads line by line via Read instances of a and accumulates context b.

Constructors

Read a => MkLineReadFn

Fields

• (a -> b -> m (b, Maybe String))

  read an element; accumulate context; and maybe an output

• (b -> m (Maybe String))

  final output

• b

  initial context

Instances

FnFunction (LineReadFn IO a b)

Defined in THSH.Fn

Methods

runFn :: LineReadFn IO a b -> (Handle, Handle, Handle) -> IO ExitCode

lineReadFn :: Read a => (a -> b -> (b, Maybe String)) -> (b -> Maybe String) -> b -> LineReadFn IO a b

Idiomatic wrapper for the MkLineReadFn

data Fn f

The new type wrapper of any FnFunction instance.

Instances

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 ()

fn :: FnFunction f => f -> Fn f

The marker for the thsh quasi-quote to recognize a FnFunction code block.