Safe Haskell	Safe-Inferred
Language	GHC2021

Polysemy.Test.Data.TestError

Description

TestError data type, Internal

Synopsis

data TestError where
- UnsafeTestError :: HasCallStack => Text -> TestError
- pattern TestError :: HasCallStack => HasCallStack => Text -> TestError
testError :: forall a r. HasCallStack => Member (Error TestError) r => Text -> Sem r a

Documentation

data TestError where Source #

An error that occurred in the test machinery.

The pattern synonym is used for construction to ensure that the call site's stack is stored. There is no IsString instance because it can't propagate the call stack. Use testError to throw a string literal.

Constructors

UnsafeTestError :: HasCallStack => Text -> TestError

Bundled Patterns

pattern TestError :: HasCallStack => HasCallStack => Text -> TestError

Construct a test error so that the call site's stack is stored in the value, for printing the correct location in hedgehog messages.

Instances

Instances details

Show TestError Source #
Instance details Defined in Polysemy.Test.Data.TestError Methods showsPrec :: Int -> TestError -> ShowS # show :: TestError -> String # showList :: [TestError] -> ShowS #
Eq TestError Source #
Instance details Defined in Polysemy.Test.Data.TestError Methods (==) :: TestError -> TestError -> Bool # (/=) :: TestError -> TestError -> Bool #

testError :: forall a r. HasCallStack => Member (Error TestError) r => Text -> Sem r a Source #

Throw a TestError with the call site's stack.