Skip to content

HORIZON HASKELL Docs lts/ghc-10.0.x77a86622026-10-31Search packagesCtrl K

Theme: |

GHC 10.0.0.20260917 · lts/ghc-10.0.x · 77a8662 · 2026-10-31

Moduletasty-silver-3.3.2.1Haskell2010

Test.Tasty.Silver.Internal

Contents

Generic utilites

Synopsis

data Golden
newtype AcceptTests
value readFileMaybe
data GDiff
data GShow
type GoldenResult
type GoldenResultI
data GoldenResult'
value runGolden
value forceGoldenResult
value ifM
value ifNotM
value and2M
value andM
value or2M
value orM

Packagetasty-silver-3.3.2.1
Exports16
LanguageHaskell2010
LicenceMIT
SourceInternal.hs

datadata Golden

See goldenTest1 for explanation of the fields.

Constructors

forall a. Golden (IO (Maybe a)) (IO a) (a -> a -> IO GDiff) (a -> IO GShow) (Maybe (a -> IO ()))

Instances1IsTest

IsTest GoldenDefined in tasty-silver-3.3.2.1 · Test.Tasty.Silver.Internal

newtypenewtype AcceptTests

This option, when set to True, specifies that we should run in the «accept tests» mode.

Constructors

AcceptTests Bool

Instances3Eq, Ord, IsOption

Eq AcceptTestsDefined in tasty-silver-3.3.2.1 · Test.Tasty.Silver.Internal
Ord AcceptTestsDefined in tasty-silver-3.3.2.1 · Test.Tasty.Silver.Internal
IsOption AcceptTestsDefined in tasty-silver-3.3.2.1 · Test.Tasty.Silver.Internal

valuereadFileMaybe :: FilePath -> IO (Maybe ByteString)

Read the file if it exists, else return Nothing. Useful for reading golden files.

datadata GDiff

The comparison/diff result.

Constructors

Equal
Values are equal.
DiffText
The two values are different, show a diff between the two given texts.
- gReason :: Maybe String
- gActual :: Text
- gExpected :: Text
ShowDiffed
The two values are different, just show the given text to the user.
- gReason :: Maybe String
- gDiff :: Text

datadata GShow

How to show a value to the user.

Constructors

ShowText Text
Show the given text.

typetype GoldenResult = GoldenResult' IO

typetype GoldenResultI = GoldenResult' Identity

datadata GoldenResult' (m :: Type -> Type)

Constructors

GREqual
forall a. GRDifferent a a GDiff (Maybe (a -> IO ()))
forall a. GRNoGolden (m a) (a -> IO GShow) (Maybe (a -> IO ()))

Instances1Show

Show (GoldenResult' m)Defined in tasty-silver-3.3.2.1 · Test.Tasty.Silver.Internal

valuerunGolden :: Golden -> IO (Result, GoldenResult)

valueforceGoldenResult :: GoldenResult -> IO GoldenResultI

Generic utilites

valueifM :: Monad m => m Bool -> m a -> m a -> m a

Monadic if.

valueifNotM :: Monad m => m Bool -> m a -> m a -> m a

Monadic if (not ...) ....

valueand2M :: Monad m => m Bool -> m Bool -> m Bool

Short-cutting version of liftM2 (&&).

valueandM :: Monad m => [m Bool] -> m Bool

Short-cutting version of and . sequence.

valueor2M :: Monad m => m Bool -> m Bool -> m Bool

Short-cutting version of liftM2 (||).

valueorM :: Monad m => [m Bool] -> m Bool

Short-cutting version of or . sequence.