Test.Chuchu.Types

Documentation

type Chuchu m = ChuchuM m ()

The most command use case where the return value of the Monad is ignored.

data ChuchuM m a where

The Monad on which the step rules are constructed. Given, When, Then, And and But are interpreted in the same way by the program. All of them receive a parser and an action to run if the parser finishes correctly.

Constructors

Given :: Parser a -> (a -> m ()) -> ChuchuM m ()

When :: Parser a -> (a -> m ()) -> ChuchuM m ()

Then :: Parser a -> (a -> m ()) -> ChuchuM m ()

And :: Parser a -> (a -> m ()) -> ChuchuM m ()

But :: Parser a -> (a -> m ()) -> ChuchuM m ()

Instances

Monad (ChuchuM m)

runChuchu :: ChuchuM m a -> Parser (m ())

Converts the Monad into a single Parser that executes the specified action if the parser is executed correctly. It includes an eof on the parser of each step to avoid it from accepting prefixes of the desired rule.