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


-- | Standard spec's for GenValidity instances
--   
--   Please see README.md
@package genvalidity-hspec
@version 0.2.0.4

module Test.Validity

-- | A concrete, poly-kinded proxy type
data Proxy k (t :: k) :: forall k. k -> *
Proxy :: Proxy k

-- | A <tt>Spec</tt> that specifies that <tt>arbitrary</tt> only generates
--   data that satisfy <tt>isValid</tt> and that <tt>shrink</tt> only
--   produces data that satisfy <tt>isValid</tt>.
--   
--   Example usage:
--   
--   <pre>
--   arbitrarySpec (Proxy :: Proxy MyData)
--   </pre>
arbitrarySpec :: (Typeable a, Show a, Validity a, Arbitrary a) => Proxy a -> Spec

-- | <tt>arbitrary</tt> only generates valid data
arbitraryGeneratesOnlyValid :: forall a. (Show a, Validity a, Arbitrary a) => Proxy a -> Property

-- | <tt>shrink</tt>, applied to valid data only produces valid data
shrinkProducesOnlyValids :: forall a. (Show a, Validity a, Arbitrary a) => Proxy a -> Property

-- | A <tt>Spec</tt> that specifies that <tt>genValid</tt> only generates
--   valid data and that <tt>genInvalid</tt> only generates invalid data.
--   
--   In general it is a good idea to add this spec to your test suite if
--   you write a custom implementation of <tt>genValid</tt> or
--   <tt>genInvalid</tt>.
--   
--   Example usage:
--   
--   <pre>
--   genValiditySpec (Proxy :: Proxy MyData)
--   </pre>
genValiditySpec :: (Typeable a, Show a, GenValidity a) => Proxy a -> Spec

-- | <tt>genValid</tt> only generates valid data
genValidityValidGeneratesValid :: forall a. (Show a, GenValidity a) => Proxy a -> Property

-- | The given generator generates only valid data points
genGeneratesValid :: (Show a, Validity a) => Gen a -> Property

-- | <tt>genValid</tt> only generates invalid data
genValidityInvalidGeneratesInvalid :: forall a. (Show a, GenValidity a) => Proxy a -> Property

-- | The given generator generates only invalid data points
genGeneratesInvalid :: (Show a, Validity a) => Gen a -> Property

-- | A <tt>Spec</tt> that specifies that <tt>isValidFor</tt> implies
--   <tt>isValid</tt>
--   
--   In general it is a good idea to add this spec to your test suite if
--   the <tt>a</tt> in <tt>RelativeValidity a b</tt> also has a
--   <tt>Validity</tt> instance.
--   
--   Example usage:
--   
--   <pre>
--   relativeValiditySpec
--       (Proxy :: Proxy MyDataFor)
--       (Proxy :: Proxy MyOtherData)
--   </pre>
relativeValiditySpec :: (Typeable a, Typeable b, Data a, Data b, Show a, Show b, GenValidity a, GenValidity b, GenRelativeValidity a b) => Proxy a -> Proxy b -> Spec

-- | <tt>isValidFor a b</tt> implies <tt>isValid a</tt> for all <tt>b</tt>
relativeValidityImpliesValidA :: (Show a, Show b, GenValidity a, GenValidity b, RelativeValidity a b) => Proxy a -> Proxy b -> Property

-- | <tt>isValidFor a b</tt> implies <tt>isValid b</tt> for all <tt>a</tt>
relativeValidityImpliesValidB :: (Show a, Show b, GenValidity a, GenValidity b, RelativeValidity a b) => Proxy a -> Proxy b -> Property

-- | A <tt>Spec</tt> that specifies that <tt>genValidFor</tt> and
--   <tt>genInvalidFor</tt> work as intended.
--   
--   In general it is a good idea to add this spec to your test suite if
--   you write a custom implementation of <tt>genValidFor</tt> or
--   <tt>genInvalidFor</tt>.
--   
--   Example usage:
--   
--   <pre>
--   relativeGenValiditySpec (proxy :: MyDataFor) (proxy :: MyOtherData)
--   </pre>
genRelativeValiditySpec :: (Typeable a, Typeable b, Show a, Show b, GenValidity a, GenValidity b, RelativeValidity a b, GenRelativeValidity a b) => Proxy a -> Proxy b -> Spec

-- | <tt>genValidFor b</tt> only generates values that satisfy
--   <tt>isValidFor b</tt>
genRelativeValidityValidGeneratesValid :: (Show a, Show b, GenValidity a, GenValidity b, RelativeValidity a b, GenRelativeValidity a b) => Proxy a -> Proxy b -> Property

-- | <tt>genInvalidFor b</tt> only generates values that do not satisfy
--   <tt>isValidFor b</tt>
genRelativeValidityInvalidGeneratesInvalid :: (Show a, Show b, GenValidity a, GenValidity b, RelativeValidity a b, GenRelativeValidity a b) => Proxy a -> Proxy b -> Property

-- | The function produces valid output when the input is generated as
--   specified by the given generator.
producesValidsOnGen :: (Show a, Show b, Validity b) => (a -> b) -> Gen a -> Property

-- | The function produces valid output when the input is generated by
--   <tt>arbitrary</tt>
producesValidsOnArbitrary :: (Show a, Show b, Arbitrary a, Validity b) => (a -> b) -> Property

-- | The function produces valid output when the input is generated by
--   <tt>genUnchecked</tt>
alwaysProducesValid :: (Show a, Show b, GenValidity a, Validity b) => (a -> b) -> Property

-- | The function produces valid output when the input is generated by
--   <tt>genValid</tt>
producesValidsOnValids :: (Show a, Show b, GenValidity a, Validity b) => (a -> b) -> Property
producesValidsOnGens2 :: (Show a, Show b, Show c, Validity c) => (a -> b -> c) -> Gen a -> Gen b -> Property
alwaysProducesValid2 :: (Show a, Show b, Show c, GenValidity a, GenValidity b, Validity c) => (a -> b -> c) -> Property
producesValidsOnValids2 :: (Show a, Show b, Show c, GenValidity a, GenValidity b, Validity c) => (a -> b -> c) -> Property
producesValidsOnGens3 :: (Show a, Show b, Show c, Show d, Validity d) => (a -> b -> c -> d) -> Gen a -> Gen b -> Gen c -> Property
alwaysProducesValid3 :: (Show a, Show b, Show c, Show d, GenValidity a, GenValidity b, GenValidity c, Validity d) => (a -> b -> c -> d) -> Property
producesValidsOnValids3 :: (Show a, Show b, Show c, Show d, GenValidity a, GenValidity b, GenValidity c, Validity d) => (a -> b -> c -> d) -> Property

-- | A class of types that are the result of functions that can fail
--   
--   You should not use this class yourself.
class CanFail f
hasFailed :: CanFail f => f a -> Bool
resultIfSucceeded :: CanFail f => f a -> Maybe a

-- | The function succeeds if the input is generated by the given generator
succeedsOnGen :: (Show a, Show b, Show (f b), CanFail f) => (a -> f b) -> Gen a -> Property

-- | The function succeeds if the input is generated by <tt>genValid</tt>
succeedsOnValidInput :: (Show a, Show b, Show (f b), GenValidity a, CanFail f) => (a -> f b) -> Property

-- | The function fails if the input is generated by the given generator
failsOnGen :: (Show a, Show b, Show (f b), CanFail f) => (a -> f b) -> Gen a -> Property

-- | The function fails if the input is generated by <tt>genInvalid</tt>
failsOnInvalidInput :: (Show a, Show b, Show (f b), GenValidity a, CanFail f) => (a -> f b) -> Property

-- | The function produces output that satisfies <tt>isValid</tt> if it is
--   given input that is generated by the given generator.
validIfSucceedsOnGen :: (Show a, Show b, Show (f b), Validity b, CanFail f) => (a -> f b) -> Gen a -> Property

-- | The function produces output that satisfies <tt>isValid</tt> if it is
--   given input that is generated by <tt>arbitrary</tt>.
validIfSucceedsOnArbitrary :: (Show a, Show b, Show (f b), Arbitrary a, Validity b, CanFail f) => (a -> f b) -> Property

-- | The function produces output that satisfies <tt>isValid</tt> if it is
--   given input that is generated by <tt>genUnchecked</tt>.
validIfSucceeds :: (Show a, Show b, Show (f b), GenValidity a, Validity b, CanFail f) => (a -> f b) -> Property
succeedsOnGens2 :: (Show a, Show b, Show c, Show (f c), CanFail f) => (a -> b -> f c) -> Gen a -> Gen b -> Property
succeedsOnValidInput2 :: (Show a, Show b, Show c, Show (f c), GenValidity a, GenValidity b, CanFail f) => (a -> b -> f c) -> Property
failsOnGens2 :: (Show a, Show b, Show c, Show (f c), CanFail f) => (a -> b -> f c) -> Gen a -> Gen b -> Property
failsOnInvalidInput2 :: (Show a, Show b, Show c, Show (f c), GenValidity a, GenValidity b, CanFail f) => (a -> b -> f c) -> Property
validIfSucceedsOnGens2 :: (Show a, Show b, Show c, Show (f c), Validity c, CanFail f) => (a -> b -> f c) -> Gen a -> Gen b -> Property
validIfSucceeds2 :: (Show a, Show b, Show c, Show (f c), GenValidity a, GenValidity b, Validity c, CanFail f) => (a -> b -> f c) -> Property
equivalentOnGen :: (Show a, Eq a, Show b, Eq b) => (a -> b) -> (a -> b) -> Gen a -> Property
equivalentOnValid :: (Show a, Eq a, GenValidity a, Show b, Eq b) => (a -> b) -> (a -> b) -> Property
equivalent :: (Show a, Eq a, GenValidity a, Show b, Eq b) => (a -> b) -> (a -> b) -> Property
equivalentOnGens2 :: (Show a, Eq a, Show b, Eq b, Show c, Eq c) => (a -> b -> c) -> (a -> b -> c) -> Gen (a, b) -> Property
equivalentOnValids2 :: (Show a, Eq a, GenValidity a, Show b, Eq b, GenValidity b, Show c, Eq c) => (a -> b -> c) -> (a -> b -> c) -> Property
equivalent2 :: (Show a, Eq a, GenValidity a, Show b, Eq b, GenValidity b, Show c, Eq c) => (a -> b -> c) -> (a -> b -> c) -> Property
equivalentWhenFirstSucceedsOnGen :: (Show a, Eq a, Show b, Eq b, CanFail f) => (a -> f b) -> (a -> b) -> Gen a -> Property
equivalentWhenFirstSucceedsOnValid :: (Show a, Eq a, GenValidity a, Show b, Eq b, CanFail f) => (a -> f b) -> (a -> b) -> Property
equivalentWhenFirstSucceeds :: (Show a, Eq a, GenValidity a, Show b, Eq b, CanFail f) => (a -> f b) -> (a -> b) -> Property
equivalentWhenFirstSucceedsOnGens2 :: (Show a, Eq a, Show b, Eq b, Show c, Eq c, CanFail f) => (a -> b -> f c) -> (a -> b -> c) -> Gen (a, b) -> Property
equivalentWhenFirstSucceedsOnValids2 :: (Show a, Eq a, GenValidity a, Show b, Eq b, GenValidity b, Show c, Eq c, CanFail f) => (a -> b -> f c) -> (a -> b -> c) -> Property
equivalentWhenFirstSucceeds2 :: (Show a, Eq a, GenValidity a, Show b, Eq b, GenValidity b, Show c, Eq c, CanFail f) => (a -> b -> f c) -> (a -> b -> c) -> Property
equivalentWhenSecondSucceedsOnGen :: (Show a, Eq a, Show b, Eq b, CanFail f) => (a -> b) -> (a -> f b) -> Gen a -> Property
equivalentWhenSecondSucceedsOnValid :: (Show a, Eq a, GenValidity a, Show b, Eq b, CanFail f) => (a -> b) -> (a -> f b) -> Property
equivalentWhenSecondSucceeds :: (Show a, Eq a, GenValidity a, Show b, Eq b, CanFail f) => (a -> b) -> (a -> f b) -> Property
equivalentWhenSecondSucceedsOnGens2 :: (Show a, Eq a, Show b, Eq b, Show c, Eq c, CanFail f) => (a -> b -> c) -> (a -> b -> f c) -> Gen (a, b) -> Property
equivalentWhenSecondSucceedsOnValids2 :: (Show a, Eq a, GenValidity a, Show b, Eq b, GenValidity b, Show c, Eq c, CanFail f) => (a -> b -> c) -> (a -> b -> f c) -> Property
equivalentWhenSecondSucceeds2 :: (Show a, Eq a, GenValidity a, Show b, Eq b, GenValidity b, Show c, Eq c, CanFail f) => (a -> b -> c) -> (a -> b -> f c) -> Property
equivalentWhenSucceedOnGen :: (Show a, Eq a, Show b, Eq b, CanFail f) => (a -> f b) -> (a -> f b) -> Gen a -> Property
equivalentWhenSucceedOnValid :: (Show a, Eq a, GenValidity a, Show b, Eq b, CanFail f) => (a -> f b) -> (a -> f b) -> Property
equivalentWhenSucceed :: (Show a, Eq a, GenValidity a, Show b, Eq b, CanFail f) => (a -> f b) -> (a -> f b) -> Property
equivalentWhenSucceedOnGens2 :: (Show a, Eq a, Show b, Eq b, Show c, Eq c, CanFail f) => (a -> b -> f c) -> (a -> b -> f c) -> Gen (a, b) -> Property
equivalentWhenSucceedOnValids2 :: (Show a, Eq a, GenValidity a, Show b, Eq b, GenValidity b, Show c, Eq c, CanFail f) => (a -> b -> f c) -> (a -> b -> f c) -> Property
equivalentWhenSucceed2 :: (Show a, Eq a, GenValidity a, Show b, Eq b, GenValidity b, Show c, Eq c, CanFail f) => (a -> b -> f c) -> (a -> b -> f c) -> Property
inverseFunctionsOnGen :: (Show a, Eq a) => (a -> b) -> (b -> a) -> Gen a -> Property
inverseFunctionsOnValid :: (Show a, Eq a, GenValidity a) => (a -> b) -> (b -> a) -> Property
inverseFunctions :: (Show a, Eq a, GenValidity a) => (a -> b) -> (b -> a) -> Property
inverseFunctionsIfFirstSucceedsOnGen :: (Show a, Eq a, CanFail f) => (a -> f b) -> (b -> a) -> Gen a -> Property
inverseFunctionsIfFirstSucceedsOnValid :: (Show a, Eq a, GenValidity a, CanFail f) => (a -> f b) -> (b -> a) -> Property
inverseFunctionsIfFirstSucceeds :: (Show a, Eq a, GenValidity a, CanFail f) => (a -> f b) -> (b -> a) -> Property
inverseFunctionsIfSecondSucceedsOnGen :: (Show a, Eq a, CanFail f) => (a -> b) -> (b -> f a) -> Gen a -> Property
inverseFunctionsIfSecondSucceedsOnValid :: (Show a, Eq a, GenValidity a, CanFail f) => (a -> b) -> (b -> f a) -> Property
inverseFunctionsIfSecondSucceeds :: (Show a, Eq a, GenValidity a, CanFail f) => (a -> b) -> (b -> f a) -> Property
inverseFunctionsIfSucceedOnGen :: (Show a, Eq a, CanFail f, CanFail g) => (a -> f b) -> (b -> g a) -> Gen a -> Property
inverseFunctionsIfSucceedOnValid :: (Show a, Eq a, GenValidity a, CanFail f, CanFail g) => (a -> f b) -> (b -> g a) -> Property
inverseFunctionsIfSucceed :: (Show a, Eq a, GenValidity a, CanFail f, CanFail g) => (a -> f b) -> (b -> g a) -> Property
reflexivityOnGen :: Show a => (a -> a -> Bool) -> Gen a -> Property
reflexivityOnValid :: (Show a, GenValidity a) => (a -> a -> Bool) -> Property
reflexivityOnUnchecked :: (Show a, GenValidity a) => (a -> a -> Bool) -> Property
transitiveOnGens :: Show a => (a -> a -> Bool) -> Gen (a, a, a) -> Property
transitiveOnValid :: (Show a, GenValidity a) => (a -> a -> Bool) -> Property
transitiveOnUnchecked :: (Show a, GenValidity a) => (a -> a -> Bool) -> Property
antisymmetryOnGensWithEquality :: Show a => (a -> a -> Bool) -> Gen (a, a) -> (a -> a -> Bool) -> Property
antisymmetryOnGensEq :: (Show a, Eq a) => (a -> a -> Bool) -> Gen (a, a) -> Property
antisymmetryOnValid :: (Show a, Eq a, GenValidity a) => (a -> a -> Bool) -> Property
leftIdentityOnGen :: (Show a, Eq a) => (b -> a -> a) -> b -> Gen a -> Property
leftIdentityOnValid :: (Show a, Eq a, GenValidity a) => (b -> a -> a) -> b -> Property
leftIdentity :: (Show a, Eq a, GenValidity a) => (b -> a -> a) -> b -> Property
rightIdentityOnGen :: (Show a, Eq a) => (a -> b -> a) -> b -> Gen a -> Property
rightIdentityOnValid :: (Show a, Eq a, GenValidity a) => (a -> b -> a) -> b -> Property
rightIdentity :: (Show a, Eq a, GenValidity a) => (a -> b -> a) -> b -> Property
identityOnGen :: (Show a, Eq a) => (a -> a -> a) -> a -> Gen a -> Property
identityOnValid :: (Show a, Eq a, GenValidity a) => (a -> a -> a) -> a -> Property
identity :: (Show a, Eq a, GenValidity a) => (a -> a -> a) -> a -> Property
associativeOnGens :: (Show a, Eq a) => (a -> a -> a) -> Gen (a, a, a) -> Property
associativeOnValids :: (Show a, Eq a, GenValidity a) => (a -> a -> a) -> Property
associative :: (Show a, Eq a, GenValidity a) => (a -> a -> a) -> Property
commutativeOnGens :: (Show a, Eq a) => (a -> a -> a) -> Gen (a, a) -> Property
commutativeOnValids :: (Show a, Eq a, GenValidity a) => (a -> a -> a) -> Property
commutative :: (Show a, Eq a, GenValidity a) => (a -> a -> a) -> Property
instance Test.Validity.CanFail GHC.Base.Maybe
instance Test.Validity.CanFail (Data.Either.Either e)