-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/

-- | Catchy combinators for HUnit
--   
--   Catchy combinators for HUnit:
--   https://github.com/sol/hspec-expectations#readme
@package hspec-expectations
@version 0.5.0.1

-- | Introductory documentation:
--   https://github.com/sol/hspec-expectations#readme
module Test.Hspec.Expectations
type Expectation = Assertion

-- | This is just an alias for HUnit's assertFailure.
expectationFailure :: String -> Expectation

-- | actual `shouldBe` expected sets the expectation that
--   actual is equal to expected (this is just an alias
--   for @?=).
shouldBe :: (Show a, Eq a) => a -> a -> Expectation

-- | v `shouldSatisfy` p sets the expectation that p v is
--   True.
shouldSatisfy :: Show a => a -> (a -> Bool) -> Expectation

-- | list `shouldContain` sublist sets the expectation that
--   sublist is contained, wholly and intact, anywhere in the
--   second.
shouldContain :: (Show a, Eq a) => [a] -> [a] -> Expectation

-- | xs `shouldMatchList` ys sets the expectation that xs
--   has the same elements that ys has, possibly in another order
shouldMatchList :: (Show a, Eq a) => [a] -> [a] -> Expectation

-- | action `shouldReturn` expected sets the expectation that
--   action returns expected.
shouldReturn :: (Show a, Eq a) => IO a -> a -> Expectation

-- | action `shouldThrow` selector sets the expectation that
--   action throws an exception. The precise nature of the
--   expected exception is described with a Selector.
shouldThrow :: Exception e => IO a -> Selector e -> Expectation

-- | A Selector is a predicate; it can simultaneously constrain
--   the type and value of an exception.
type Selector a = a -> Bool
anyException :: Selector SomeException
anyErrorCall :: Selector ErrorCall
anyIOException :: Selector IOException
anyArithException :: Selector ArithException
errorCall :: String -> Selector ErrorCall

-- | Experimental combinators, that may become part of the main
--   distribution, if they turn out to be useful for a wider audience.
module Test.Hspec.Expectations.Contrib
isLeft :: Either a b -> Bool
isRight :: Either a b -> Bool
