Stability	experimental
Safe Haskell	Safe-Inferred
Language	Haskell2010

Test.Hspec.Core.Format

Description

Synopsis

type Format = Event -> IO ()
data FormatConfig = FormatConfig {
- formatConfigUseColor :: Bool
- formatConfigReportProgress :: Bool
- formatConfigOutputUnicode :: Bool
- formatConfigUseDiff :: Bool
- formatConfigPrettyPrint :: Bool
- formatConfigPrintTimes :: Bool
- formatConfigHtmlOutput :: Bool
- formatConfigPrintCpuTime :: Bool
- formatConfigUsedSeed :: Integer
- formatConfigExpectedTotalCount :: Int
}
data Event
- = Started
- | GroupStarted Path
- | GroupDone Path
- | Progress Path Progress
- | ItemStarted Path
- | ItemDone Path Item
- | Done [(Path, Item)]
type Progress = (Int, Int)
type Path = ([String], String)
data Location = Location {
- locationFile :: FilePath
- locationLine :: Int
- locationColumn :: Int
}
newtype Seconds = Seconds Double
data Item = Item {
- itemLocation :: Maybe Location
- itemDuration :: Seconds
- itemInfo :: String
- itemResult :: Result
}
data Result
- = Success
- | Pending (Maybe Location) (Maybe String)
- | Failure (Maybe Location) FailureReason
data FailureReason
- = NoReason
- | Reason String
- | ExpectedButGot (Maybe String) String String
- | Error (Maybe String) SomeException
monadic :: MonadIO m => (m () -> IO ()) -> (Event -> m ()) -> IO Format

Documentation

type Format = Event -> IO () Source #

data FormatConfig Source #

Constructors

FormatConfig
Fields formatConfigUseColor :: Bool formatConfigReportProgress :: Bool formatConfigOutputUnicode :: Bool formatConfigUseDiff :: Bool formatConfigPrettyPrint :: Bool formatConfigPrintTimes :: Bool formatConfigHtmlOutput :: Bool formatConfigPrintCpuTime :: Bool formatConfigUsedSeed :: Integer formatConfigExpectedTotalCount :: Int

Instances

Instances details

Show FormatConfig Source #
Instance details Defined in Test.Hspec.Core.Format Methods showsPrec :: Int -> FormatConfig -> ShowS show :: FormatConfig -> String showList :: [FormatConfig] -> ShowS
Eq FormatConfig Source #
Instance details Defined in Test.Hspec.Core.Format Methods (==) :: FormatConfig -> FormatConfig -> Bool (/=) :: FormatConfig -> FormatConfig -> Bool

data Event Source #

Constructors

Started
GroupStarted Path
GroupDone Path
Progress Path Progress
ItemStarted Path
ItemDone Path Item
Done [(Path, Item)]

Instances

Instances details

Show Event Source #
Instance details Defined in Test.Hspec.Core.Format Methods showsPrec :: Int -> Event -> ShowS show :: Event -> String showList :: [Event] -> ShowS

type Progress = (Int, Int) Source #

type Path = ([String], String) Source #

A Path describes the location of a spec item within a spec tree.

It consists of a list of group descriptions and a requirement description.

data Location Source #

Location is used to represent source locations.

Constructors

Location
Fields locationFile :: FilePath locationLine :: Int locationColumn :: Int

Instances

Instances details

Read Location Source #
Instance details Defined in Test.Hspec.Core.Example.Location Methods readsPrec :: Int -> ReadS Location readList :: ReadS [Location] readPrec :: ReadPrec Location readListPrec :: ReadPrec [Location]
Show Location Source #
Instance details Defined in Test.Hspec.Core.Example.Location Methods showsPrec :: Int -> Location -> ShowS show :: Location -> String showList :: [Location] -> ShowS
Eq Location Source #
Instance details Defined in Test.Hspec.Core.Example.Location Methods (==) :: Location -> Location -> Bool (/=) :: Location -> Location -> Bool

newtype Seconds Source #

Constructors

Seconds Double

Instances

Instances details

Num Seconds Source #
Instance details Defined in Test.Hspec.Core.Clock Methods (+) :: Seconds -> Seconds -> Seconds (-) :: Seconds -> Seconds -> Seconds (*) :: Seconds -> Seconds -> Seconds negate :: Seconds -> Seconds abs :: Seconds -> Seconds signum :: Seconds -> Seconds fromInteger :: Integer -> Seconds
Fractional Seconds Source #
Instance details Defined in Test.Hspec.Core.Clock Methods (/) :: Seconds -> Seconds -> Seconds recip :: Seconds -> Seconds fromRational :: Rational -> Seconds
Show Seconds Source #
Instance details Defined in Test.Hspec.Core.Clock Methods showsPrec :: Int -> Seconds -> ShowS show :: Seconds -> String showList :: [Seconds] -> ShowS
PrintfArg Seconds Source #
Instance details Defined in Test.Hspec.Core.Clock Methods formatArg :: Seconds -> FieldFormatter parseFormat :: Seconds -> ModifierParser
Eq Seconds Source #
Instance details Defined in Test.Hspec.Core.Clock Methods (==) :: Seconds -> Seconds -> Bool (/=) :: Seconds -> Seconds -> Bool
Ord Seconds Source #
Instance details Defined in Test.Hspec.Core.Clock Methods compare :: Seconds -> Seconds -> Ordering (<) :: Seconds -> Seconds -> Bool (<=) :: Seconds -> Seconds -> Bool (>) :: Seconds -> Seconds -> Bool (>=) :: Seconds -> Seconds -> Bool max :: Seconds -> Seconds -> Seconds min :: Seconds -> Seconds -> Seconds

data Item Source #

Constructors

Item
Fields itemLocation :: Maybe Location itemDuration :: Seconds itemInfo :: String itemResult :: Result

Instances

Instances details

Show Item Source #
Instance details Defined in Test.Hspec.Core.Format Methods showsPrec :: Int -> Item -> ShowS show :: Item -> String showList :: [Item] -> ShowS

data Result Source #

Constructors

Success
Pending (Maybe Location) (Maybe String)
Failure (Maybe Location) FailureReason

Instances

Instances details

Show Result Source #
Instance details Defined in Test.Hspec.Core.Format Methods showsPrec :: Int -> Result -> ShowS show :: Result -> String showList :: [Result] -> ShowS

data FailureReason Source #

Constructors

NoReason
Reason String
ExpectedButGot (Maybe String) String String
Error (Maybe String) SomeException

Instances

Instances details

Show FailureReason Source #
Instance details Defined in Test.Hspec.Core.Example Methods showsPrec :: Int -> FailureReason -> ShowS show :: FailureReason -> String showList :: [FailureReason] -> ShowS
NFData FailureReason Source #
Instance details Defined in Test.Hspec.Core.Example Methods rnf :: FailureReason -> ()

monadic :: MonadIO m => (m () -> IO ()) -> (Event -> m ()) -> IO Format Source #