/usr/share/doc/libghc-hspec-core-doc/html/Test-Hspec-Core-Spec.html is in libghc-hspec-core-doc 2.2.4-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Test.Hspec.Core.Spec</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script src="file:///usr/share/javascript/mathjax/MathJax.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
window.onload = function () {pageLoad();setSynopsis("mini_Test-Hspec-Core-Spec.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Test-Hspec-Core-Spec.html">Source</a></li><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">hspec-core-2.2.4: A Testing Framework for Haskell</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Stability</th><td>unstable</td></tr><tr><th>Safe Haskell</th><td>None</td></tr><tr><th>Language</th><td>Haskell2010</td></tr></table><p class="caption">Test.Hspec.Core.Spec</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1">Defining a spec</a></li><li><a href="#g:2">The <code>SpecM</code> monad</a></li><li><a href="#g:3">A type class for examples</a></li><li><a href="#g:4">Internal representation of a spec tree</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>This module provides access to Hspec's internals. It is less stable than
other parts of the API. For most users <code>Test.Hspec</code> is more suitable!</p></div></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><a href="#v:describe">describe</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-String.html#t:String">String</a> -> <a href="Test-Hspec-Core-Spec.html#t:SpecWith">SpecWith</a> a -> <a href="Test-Hspec-Core-Spec.html#t:SpecWith">SpecWith</a> a</li><li class="src short"><a href="#v:it">it</a> :: (?loc :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/GHC-Stack.html#t:CallStack">CallStack</a>, <a href="Test-Hspec-Core-Spec.html#t:Example">Example</a> a) => <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-String.html#t:String">String</a> -> a -> <a href="Test-Hspec-Core-Spec.html#t:SpecWith">SpecWith</a> (<a href="Test-Hspec-Core-Spec.html#t:Arg">Arg</a> a)</li><li class="src short"><a href="#v:pending">pending</a> :: <a href="file:///usr/share/doc/libghc-hspec-expectations-doc/html/Test-Hspec-Expectations.html#t:Expectation">Expectation</a></li><li class="src short"><a href="#v:pendingWith">pendingWith</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-String.html#t:String">String</a> -> <a href="file:///usr/share/doc/libghc-hspec-expectations-doc/html/Test-Hspec-Expectations.html#t:Expectation">Expectation</a></li><li class="src short"><a href="#v:parallel">parallel</a> :: <a href="Test-Hspec-Core-Spec.html#t:SpecWith">SpecWith</a> a -> <a href="Test-Hspec-Core-Spec.html#t:SpecWith">SpecWith</a> a</li><li class="src short"><span class="keyword">type</span> <a href="#t:Spec">Spec</a> = <a href="Test-Hspec-Core-Spec.html#t:SpecWith">SpecWith</a> ()</li><li class="src short"><span class="keyword">type</span> <a href="#t:SpecWith">SpecWith</a> a = <a href="Test-Hspec-Core-Spec.html#t:SpecM">SpecM</a> a ()</li><li class="src short"><span class="keyword">newtype</span> <a href="#t:SpecM">SpecM</a> a r = <a href="#v:SpecM">SpecM</a> (<a href="file:///usr/share/doc/ghc-doc/html/libraries/transformers-0.5.2.0/Control-Monad-Trans-Writer-Lazy.html#t:WriterT">WriterT</a> [<a href="Test-Hspec-Core-Spec.html#t:SpecTree">SpecTree</a> a] <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/System-IO.html#t:IO">IO</a> r)</li><li class="src short"><a href="#v:runSpecM">runSpecM</a> :: <a href="Test-Hspec-Core-Spec.html#t:SpecWith">SpecWith</a> a -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/System-IO.html#t:IO">IO</a> [<a href="Test-Hspec-Core-Spec.html#t:SpecTree">SpecTree</a> a]</li><li class="src short"><a href="#v:fromSpecList">fromSpecList</a> :: [<a href="Test-Hspec-Core-Spec.html#t:SpecTree">SpecTree</a> a] -> <a href="Test-Hspec-Core-Spec.html#t:SpecWith">SpecWith</a> a</li><li class="src short"><a href="#v:runIO">runIO</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/System-IO.html#t:IO">IO</a> r -> <a href="Test-Hspec-Core-Spec.html#t:SpecM">SpecM</a> a r</li><li class="src short"><a href="#v:mapSpecTree">mapSpecTree</a> :: (<a href="Test-Hspec-Core-Spec.html#t:SpecTree">SpecTree</a> a -> <a href="Test-Hspec-Core-Spec.html#t:SpecTree">SpecTree</a> b) -> <a href="Test-Hspec-Core-Spec.html#t:SpecWith">SpecWith</a> a -> <a href="Test-Hspec-Core-Spec.html#t:SpecWith">SpecWith</a> b</li><li class="src short"><a href="#v:mapSpecItem">mapSpecItem</a> :: (<a href="Test-Hspec-Core-Spec.html#t:ActionWith">ActionWith</a> a -> <a href="Test-Hspec-Core-Spec.html#t:ActionWith">ActionWith</a> b) -> (<a href="Test-Hspec-Core-Spec.html#t:Item">Item</a> a -> <a href="Test-Hspec-Core-Spec.html#t:Item">Item</a> b) -> <a href="Test-Hspec-Core-Spec.html#t:SpecWith">SpecWith</a> a -> <a href="Test-Hspec-Core-Spec.html#t:SpecWith">SpecWith</a> b</li><li class="src short"><a href="#v:mapSpecItem_">mapSpecItem_</a> :: (<a href="Test-Hspec-Core-Spec.html#t:Item">Item</a> a -> <a href="Test-Hspec-Core-Spec.html#t:Item">Item</a> a) -> <a href="Test-Hspec-Core-Spec.html#t:SpecWith">SpecWith</a> a -> <a href="Test-Hspec-Core-Spec.html#t:SpecWith">SpecWith</a> a</li><li class="src short"><a href="#v:modifyParams">modifyParams</a> :: (<a href="Test-Hspec-Core-Spec.html#t:Params">Params</a> -> <a href="Test-Hspec-Core-Spec.html#t:Params">Params</a>) -> <a href="Test-Hspec-Core-Spec.html#t:SpecWith">SpecWith</a> a -> <a href="Test-Hspec-Core-Spec.html#t:SpecWith">SpecWith</a> a</li><li class="src short"><span class="keyword">class</span> <a href="#t:Example">Example</a> e <span class="keyword">where</span><ul class="subs"><li><span class="keyword">type</span> <a href="#t:Arg">Arg</a> e</li></ul></li><li class="src short"><span class="keyword">data</span> <a href="#t:Params">Params</a> = <a href="#v:Params">Params</a> {<ul class="subs"><li><a href="#v:paramsQuickCheckArgs">paramsQuickCheckArgs</a> :: <a href="file:///usr/share/doc/libghc-quickcheck2-doc/html/Test-QuickCheck-Test.html#t:Args">Args</a></li><li><a href="#v:paramsSmallCheckDepth">paramsSmallCheckDepth</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Int.html#t:Int">Int</a></li></ul>}</li><li class="src short"><a href="#v:defaultParams">defaultParams</a> :: <a href="Test-Hspec-Core-Spec.html#t:Params">Params</a></li><li class="src short"><span class="keyword">type</span> <a href="#t:ActionWith">ActionWith</a> a = a -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/System-IO.html#t:IO">IO</a> ()</li><li class="src short"><span class="keyword">type</span> <a href="#t:Progress">Progress</a> = (<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Int.html#t:Int">Int</a>, <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Int.html#t:Int">Int</a>)</li><li class="src short"><span class="keyword">type</span> <a href="#t:ProgressCallback">ProgressCallback</a> = <a href="Test-Hspec-Core-Spec.html#t:Progress">Progress</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/System-IO.html#t:IO">IO</a> ()</li><li class="src short"><span class="keyword">data</span> <a href="#t:Result">Result</a><ul class="subs"><li>= <a href="#v:Success">Success</a></li><li>| <a href="#v:Pending">Pending</a> (<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-String.html#t:String">String</a>)</li><li>| <a href="#v:Fail">Fail</a> (<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Test-Hspec-Core-Spec.html#t:Location">Location</a>) <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-String.html#t:String">String</a></li></ul></li><li class="src short"><span class="keyword">data</span> <a href="#t:Location">Location</a> = <a href="#v:Location">Location</a> {<ul class="subs"><li><a href="#v:locationFile">locationFile</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/System-IO.html#t:FilePath">FilePath</a></li><li><a href="#v:locationLine">locationLine</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Int.html#t:Int">Int</a></li><li><a href="#v:locationColumn">locationColumn</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Int.html#t:Int">Int</a></li><li><a href="#v:locationAccuracy">locationAccuracy</a> :: <a href="Test-Hspec-Core-Spec.html#t:LocationAccuracy">LocationAccuracy</a></li></ul>}</li><li class="src short"><span class="keyword">data</span> <a href="#t:LocationAccuracy">LocationAccuracy</a><ul class="subs"><li>= <a href="#v:ExactLocation">ExactLocation</a></li><li>| <a href="#v:BestEffort">BestEffort</a></li></ul></li><li class="src short"><span class="keyword">type</span> <a href="#t:SpecTree">SpecTree</a> a = <a href="Test-Hspec-Core-Spec.html#t:Tree">Tree</a> (<a href="Test-Hspec-Core-Spec.html#t:ActionWith">ActionWith</a> a) (<a href="Test-Hspec-Core-Spec.html#t:Item">Item</a> a)</li><li class="src short"><span class="keyword">data</span> <a href="#t:Tree">Tree</a> c a<ul class="subs"><li>= <a href="#v:Node">Node</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-String.html#t:String">String</a> [<a href="Test-Hspec-Core-Spec.html#t:Tree">Tree</a> c a]</li><li>| <a href="#v:NodeWithCleanup">NodeWithCleanup</a> c [<a href="Test-Hspec-Core-Spec.html#t:Tree">Tree</a> c a]</li><li>| <a href="#v:Leaf">Leaf</a> a</li></ul></li><li class="src short"><span class="keyword">data</span> <a href="#t:Item">Item</a> a = <a href="#v:Item">Item</a> {<ul class="subs"><li><a href="#v:itemRequirement">itemRequirement</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-String.html#t:String">String</a></li><li><a href="#v:itemLocation">itemLocation</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Test-Hspec-Core-Spec.html#t:Location">Location</a></li><li><a href="#v:itemIsParallelizable">itemIsParallelizable</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Bool.html#t:Bool">Bool</a></li><li><a href="#v:itemExample">itemExample</a> :: <a href="Test-Hspec-Core-Spec.html#t:Params">Params</a> -> (<a href="Test-Hspec-Core-Spec.html#t:ActionWith">ActionWith</a> a -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/System-IO.html#t:IO">IO</a> ()) -> <a href="Test-Hspec-Core-Spec.html#t:ProgressCallback">ProgressCallback</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/System-IO.html#t:IO">IO</a> <a href="Test-Hspec-Core-Spec.html#t:Result">Result</a></li></ul>}</li><li class="src short"><a href="#v:specGroup">specGroup</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-String.html#t:String">String</a> -> [<a href="Test-Hspec-Core-Spec.html#t:SpecTree">SpecTree</a> a] -> <a href="Test-Hspec-Core-Spec.html#t:SpecTree">SpecTree</a> a</li><li class="src short"><a href="#v:specItem">specItem</a> :: (?loc :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/GHC-Stack.html#t:CallStack">CallStack</a>, <a href="Test-Hspec-Core-Spec.html#t:Example">Example</a> a) => <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-String.html#t:String">String</a> -> a -> <a href="Test-Hspec-Core-Spec.html#t:SpecTree">SpecTree</a> (<a href="Test-Hspec-Core-Spec.html#t:Arg">Arg</a> a)</li></ul></div><div id="interface"><h1 id="g:1">Defining a spec</h1><div class="top"><p class="src"><a id="v:describe" class="def">describe</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-String.html#t:String">String</a> -> <a href="Test-Hspec-Core-Spec.html#t:SpecWith">SpecWith</a> a -> <a href="Test-Hspec-Core-Spec.html#t:SpecWith">SpecWith</a> a <a href="src/Test-Hspec-Core-Spec.html#describe" class="link">Source</a> <a href="#v:describe" class="selflink">#</a></p><div class="doc"><p>The <code>describe</code> function combines a list of specs into a larger spec.</p></div></div><div class="top"><p class="src"><a id="v:it" class="def">it</a> :: (?loc :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/GHC-Stack.html#t:CallStack">CallStack</a>, <a href="Test-Hspec-Core-Spec.html#t:Example">Example</a> a) => <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-String.html#t:String">String</a> -> a -> <a href="Test-Hspec-Core-Spec.html#t:SpecWith">SpecWith</a> (<a href="Test-Hspec-Core-Spec.html#t:Arg">Arg</a> a) <a href="src/Test-Hspec-Core-Spec.html#it" class="link">Source</a> <a href="#v:it" class="selflink">#</a></p><div class="doc"><p>The <code>it</code> function creates a spec item.</p><p>A spec item consists of:</p><ul><li>a textual description of a desired behavior</li><li>an example for that behavior</li></ul><pre>describe "absolute" $ do
it "returns a positive number when given a negative number" $
absolute (-1) == 1</pre></div></div><div class="top"><p class="src"><a id="v:pending" class="def">pending</a> :: <a href="file:///usr/share/doc/libghc-hspec-expectations-doc/html/Test-Hspec-Expectations.html#t:Expectation">Expectation</a> <a href="src/Test-Hspec-Core-Spec.html#pending" class="link">Source</a> <a href="#v:pending" class="selflink">#</a></p><div class="doc"><p><code><a href="Test-Hspec-Core-Spec.html#v:pending">pending</a></code> can be used to indicate that an example is <em>pending</em>.</p><p>If you want to textually specify a behavior but do not have an example yet,
use this:</p><pre>describe "fancyFormatter" $ do
it "can format text in a way that everyone likes" $
pending</pre></div></div><div class="top"><p class="src"><a id="v:pendingWith" class="def">pendingWith</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-String.html#t:String">String</a> -> <a href="file:///usr/share/doc/libghc-hspec-expectations-doc/html/Test-Hspec-Expectations.html#t:Expectation">Expectation</a> <a href="src/Test-Hspec-Core-Spec.html#pendingWith" class="link">Source</a> <a href="#v:pendingWith" class="selflink">#</a></p><div class="doc"><p><code><a href="Test-Hspec-Core-Spec.html#v:pendingWith">pendingWith</a></code> is similar to <code><a href="Test-Hspec-Core-Spec.html#v:pending">pending</a></code>, but it takes an additional string
argument that can be used to specify the reason for why it's pending.</p></div></div><div class="top"><p class="src"><a id="v:parallel" class="def">parallel</a> :: <a href="Test-Hspec-Core-Spec.html#t:SpecWith">SpecWith</a> a -> <a href="Test-Hspec-Core-Spec.html#t:SpecWith">SpecWith</a> a <a href="src/Test-Hspec-Core-Spec.html#parallel" class="link">Source</a> <a href="#v:parallel" class="selflink">#</a></p><div class="doc"><p><code><a href="Test-Hspec-Core-Spec.html#v:parallel">parallel</a></code> marks all spec items of the given spec to be safe for parallel
evaluation.</p></div></div><h1 id="g:2">The <code>SpecM</code> monad</h1><div class="top"><p class="src"><span class="keyword">type</span> <a id="t:Spec" class="def">Spec</a> = <a href="Test-Hspec-Core-Spec.html#t:SpecWith">SpecWith</a> () <a href="src/Test-Hspec-Core-Spec-Monad.html#Spec" class="link">Source</a> <a href="#t:Spec" class="selflink">#</a></p></div><div class="top"><p class="src"><span class="keyword">type</span> <a id="t:SpecWith" class="def">SpecWith</a> a = <a href="Test-Hspec-Core-Spec.html#t:SpecM">SpecM</a> a () <a href="src/Test-Hspec-Core-Spec-Monad.html#SpecWith" class="link">Source</a> <a href="#t:SpecWith" class="selflink">#</a></p></div><div class="top"><p class="src"><span class="keyword">newtype</span> <a id="t:SpecM" class="def">SpecM</a> a r <a href="src/Test-Hspec-Core-Spec-Monad.html#SpecM" class="link">Source</a> <a href="#t:SpecM" class="selflink">#</a></p><div class="doc"><p>A writer monad for <code><a href="Test-Hspec-Core-Spec.html#t:SpecTree">SpecTree</a></code> forests</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a id="v:SpecM" class="def">SpecM</a> (<a href="file:///usr/share/doc/ghc-doc/html/libraries/transformers-0.5.2.0/Control-Monad-Trans-Writer-Lazy.html#t:WriterT">WriterT</a> [<a href="Test-Hspec-Core-Spec.html#t:SpecTree">SpecTree</a> a] <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/System-IO.html#t:IO">IO</a> r)</td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:SpecM" class="caption collapser" onclick="toggleSection('i:SpecM')">Instances</p><div id="section.i:SpecM" class="show"><table><tr><td class="src clearfix"><span class="inst-left"><span id="control.i:id:SpecM:Monad:1" class="instance expander" onclick="toggleSection('i:id:SpecM:Monad:1')"></span> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Control-Monad.html#t:Monad">Monad</a> (<a href="Test-Hspec-Core-Spec.html#t:SpecM">SpecM</a> a)</span> <a href="src/Test-Hspec-Core-Spec-Monad.html#line-31" class="link">Source</a> <a href="#t:SpecM" class="selflink">#</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div id="section.i:id:SpecM:Monad:1" class="inst-details hide"><div class="subs methods"><p class="caption">Methods</p><p class="src"><a href="#v:-62--62--61-">(>>=)</a> :: <a href="Test-Hspec-Core-Spec.html#t:SpecM">SpecM</a> a a -> (a -> <a href="Test-Hspec-Core-Spec.html#t:SpecM">SpecM</a> a b) -> <a href="Test-Hspec-Core-Spec.html#t:SpecM">SpecM</a> a b <a href="#v:-62--62--61-" class="selflink">#</a></p><p class="src"><a href="#v:-62--62-">(>>)</a> :: <a href="Test-Hspec-Core-Spec.html#t:SpecM">SpecM</a> a a -> <a href="Test-Hspec-Core-Spec.html#t:SpecM">SpecM</a> a b -> <a href="Test-Hspec-Core-Spec.html#t:SpecM">SpecM</a> a b <a href="#v:-62--62-" class="selflink">#</a></p><p class="src"><a href="#v:return">return</a> :: a -> <a href="Test-Hspec-Core-Spec.html#t:SpecM">SpecM</a> a a <a href="#v:return" class="selflink">#</a></p><p class="src"><a href="#v:fail">fail</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-String.html#t:String">String</a> -> <a href="Test-Hspec-Core-Spec.html#t:SpecM">SpecM</a> a a <a href="#v:fail" class="selflink">#</a></p></div></div></td></tr><tr><td class="src clearfix"><span class="inst-left"><span id="control.i:id:SpecM:Functor:2" class="instance expander" onclick="toggleSection('i:id:SpecM:Functor:2')"></span> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Functor.html#t:Functor">Functor</a> (<a href="Test-Hspec-Core-Spec.html#t:SpecM">SpecM</a> a)</span> <a href="src/Test-Hspec-Core-Spec-Monad.html#line-31" class="link">Source</a> <a href="#t:SpecM" class="selflink">#</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div id="section.i:id:SpecM:Functor:2" class="inst-details hide"><div class="subs methods"><p class="caption">Methods</p><p class="src"><a href="#v:fmap">fmap</a> :: (a -> b) -> <a href="Test-Hspec-Core-Spec.html#t:SpecM">SpecM</a> a a -> <a href="Test-Hspec-Core-Spec.html#t:SpecM">SpecM</a> a b <a href="#v:fmap" class="selflink">#</a></p><p class="src"><a href="#v:-60--36-">(<$)</a> :: a -> <a href="Test-Hspec-Core-Spec.html#t:SpecM">SpecM</a> a b -> <a href="Test-Hspec-Core-Spec.html#t:SpecM">SpecM</a> a a <a href="#v:-60--36-" class="selflink">#</a></p></div></div></td></tr><tr><td class="src clearfix"><span class="inst-left"><span id="control.i:id:SpecM:Applicative:3" class="instance expander" onclick="toggleSection('i:id:SpecM:Applicative:3')"></span> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Control-Applicative.html#t:Applicative">Applicative</a> (<a href="Test-Hspec-Core-Spec.html#t:SpecM">SpecM</a> a)</span> <a href="src/Test-Hspec-Core-Spec-Monad.html#line-31" class="link">Source</a> <a href="#t:SpecM" class="selflink">#</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div id="section.i:id:SpecM:Applicative:3" class="inst-details hide"><div class="subs methods"><p class="caption">Methods</p><p class="src"><a href="#v:pure">pure</a> :: a -> <a href="Test-Hspec-Core-Spec.html#t:SpecM">SpecM</a> a a <a href="#v:pure" class="selflink">#</a></p><p class="src"><a href="#v:-60--42--62-">(<*>)</a> :: <a href="Test-Hspec-Core-Spec.html#t:SpecM">SpecM</a> a (a -> b) -> <a href="Test-Hspec-Core-Spec.html#t:SpecM">SpecM</a> a a -> <a href="Test-Hspec-Core-Spec.html#t:SpecM">SpecM</a> a b <a href="#v:-60--42--62-" class="selflink">#</a></p><p class="src"><a href="#v:-42--62-">(*>)</a> :: <a href="Test-Hspec-Core-Spec.html#t:SpecM">SpecM</a> a a -> <a href="Test-Hspec-Core-Spec.html#t:SpecM">SpecM</a> a b -> <a href="Test-Hspec-Core-Spec.html#t:SpecM">SpecM</a> a b <a href="#v:-42--62-" class="selflink">#</a></p><p class="src"><a href="#v:-60--42-">(<*)</a> :: <a href="Test-Hspec-Core-Spec.html#t:SpecM">SpecM</a> a a -> <a href="Test-Hspec-Core-Spec.html#t:SpecM">SpecM</a> a b -> <a href="Test-Hspec-Core-Spec.html#t:SpecM">SpecM</a> a a <a href="#v:-60--42-" class="selflink">#</a></p></div></div></td></tr></table></div></div></div><div class="top"><p class="src"><a id="v:runSpecM" class="def">runSpecM</a> :: <a href="Test-Hspec-Core-Spec.html#t:SpecWith">SpecWith</a> a -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/System-IO.html#t:IO">IO</a> [<a href="Test-Hspec-Core-Spec.html#t:SpecTree">SpecTree</a> a] <a href="src/Test-Hspec-Core-Spec-Monad.html#runSpecM" class="link">Source</a> <a href="#v:runSpecM" class="selflink">#</a></p><div class="doc"><p>Convert a <code><a href="Test-Hspec-Core-Spec.html#t:Spec">Spec</a></code> to a forest of <code><a href="Test-Hspec-Core-Spec.html#t:SpecTree">SpecTree</a></code>s.</p></div></div><div class="top"><p class="src"><a id="v:fromSpecList" class="def">fromSpecList</a> :: [<a href="Test-Hspec-Core-Spec.html#t:SpecTree">SpecTree</a> a] -> <a href="Test-Hspec-Core-Spec.html#t:SpecWith">SpecWith</a> a <a href="src/Test-Hspec-Core-Spec-Monad.html#fromSpecList" class="link">Source</a> <a href="#v:fromSpecList" class="selflink">#</a></p><div class="doc"><p>Create a <code><a href="Test-Hspec-Core-Spec.html#t:Spec">Spec</a></code> from a forest of <code><a href="Test-Hspec-Core-Spec.html#t:SpecTree">SpecTree</a></code>s.</p></div></div><div class="top"><p class="src"><a id="v:runIO" class="def">runIO</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/System-IO.html#t:IO">IO</a> r -> <a href="Test-Hspec-Core-Spec.html#t:SpecM">SpecM</a> a r <a href="src/Test-Hspec-Core-Spec-Monad.html#runIO" class="link">Source</a> <a href="#v:runIO" class="selflink">#</a></p><div class="doc"><p>Run an IO action while constructing the spec tree.</p><p><code><a href="Test-Hspec-Core-Spec.html#t:SpecM">SpecM</a></code> is a monad to construct a spec tree, without executing any spec
items. <code>runIO</code> allows you to run IO actions during this construction phase.
The IO action is always run when the spec tree is constructed (e.g. even
when <code>--dry-run</code> is specified).
If you do not need the result of the IO action to construct the spec tree,
<code><a href="Test-Hspec-Core-Hooks.html#v:beforeAll">beforeAll</a></code> may be more suitable for your use case.</p></div></div><div class="top"><p class="src"><a id="v:mapSpecTree" class="def">mapSpecTree</a> :: (<a href="Test-Hspec-Core-Spec.html#t:SpecTree">SpecTree</a> a -> <a href="Test-Hspec-Core-Spec.html#t:SpecTree">SpecTree</a> b) -> <a href="Test-Hspec-Core-Spec.html#t:SpecWith">SpecWith</a> a -> <a href="Test-Hspec-Core-Spec.html#t:SpecWith">SpecWith</a> b <a href="src/Test-Hspec-Core-Spec-Monad.html#mapSpecTree" class="link">Source</a> <a href="#v:mapSpecTree" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:mapSpecItem" class="def">mapSpecItem</a> :: (<a href="Test-Hspec-Core-Spec.html#t:ActionWith">ActionWith</a> a -> <a href="Test-Hspec-Core-Spec.html#t:ActionWith">ActionWith</a> b) -> (<a href="Test-Hspec-Core-Spec.html#t:Item">Item</a> a -> <a href="Test-Hspec-Core-Spec.html#t:Item">Item</a> b) -> <a href="Test-Hspec-Core-Spec.html#t:SpecWith">SpecWith</a> a -> <a href="Test-Hspec-Core-Spec.html#t:SpecWith">SpecWith</a> b <a href="src/Test-Hspec-Core-Spec-Monad.html#mapSpecItem" class="link">Source</a> <a href="#v:mapSpecItem" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:mapSpecItem_" class="def">mapSpecItem_</a> :: (<a href="Test-Hspec-Core-Spec.html#t:Item">Item</a> a -> <a href="Test-Hspec-Core-Spec.html#t:Item">Item</a> a) -> <a href="Test-Hspec-Core-Spec.html#t:SpecWith">SpecWith</a> a -> <a href="Test-Hspec-Core-Spec.html#t:SpecWith">SpecWith</a> a <a href="src/Test-Hspec-Core-Spec-Monad.html#mapSpecItem_" class="link">Source</a> <a href="#v:mapSpecItem_" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:modifyParams" class="def">modifyParams</a> :: (<a href="Test-Hspec-Core-Spec.html#t:Params">Params</a> -> <a href="Test-Hspec-Core-Spec.html#t:Params">Params</a>) -> <a href="Test-Hspec-Core-Spec.html#t:SpecWith">SpecWith</a> a -> <a href="Test-Hspec-Core-Spec.html#t:SpecWith">SpecWith</a> a <a href="src/Test-Hspec-Core-Spec-Monad.html#modifyParams" class="link">Source</a> <a href="#v:modifyParams" class="selflink">#</a></p></div><h1 id="g:3">A type class for examples</h1><div class="top"><p class="src"><span class="keyword">class</span> <a id="t:Example" class="def">Example</a> e <span class="keyword">where</span> <a href="src/Test-Hspec-Core-Example.html#Example" class="link">Source</a> <a href="#t:Example" class="selflink">#</a></p><div class="doc"><p>A type class for examples</p></div><div class="subs minimal"><p class="caption">Minimal complete definition</p><p class="src"><a href="Test-Hspec-Core-Spec.html#v:evaluateExample">evaluateExample</a></p></div><div class="subs associated-types"><p class="caption">Associated Types</p><p class="src"><span class="keyword">type</span> <a id="t:Arg" class="def">Arg</a> e <a href="src/Test-Hspec-Core-Example.html#Arg" class="link">Source</a> <a href="#t:Arg" class="selflink">#</a></p></div><div class="subs methods"><p class="caption">Methods</p><p class="src"><a id="v:evaluateExample" class="def">evaluateExample</a> :: e -> <a href="Test-Hspec-Core-Spec.html#t:Params">Params</a> -> (<a href="Test-Hspec-Core-Spec.html#t:ActionWith">ActionWith</a> (<a href="Test-Hspec-Core-Spec.html#t:Arg">Arg</a> e) -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/System-IO.html#t:IO">IO</a> ()) -> <a href="Test-Hspec-Core-Spec.html#t:ProgressCallback">ProgressCallback</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/System-IO.html#t:IO">IO</a> <a href="Test-Hspec-Core-Spec.html#t:Result">Result</a> <a href="src/Test-Hspec-Core-Example.html#evaluateExample" class="link">Source</a> <a href="#v:evaluateExample" class="selflink">#</a></p></div><div class="subs instances"><p id="control.i:Example" class="caption collapser" onclick="toggleSection('i:Example')">Instances</p><div id="section.i:Example" class="show"><table><tr><td class="src clearfix"><span class="inst-left"><span id="control.i:ic:Example:Example:1" class="instance expander" onclick="toggleSection('i:ic:Example:Example:1')"></span> <a href="Test-Hspec-Core-Spec.html#t:Example">Example</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Bool.html#t:Bool">Bool</a></span> <a href="src/Test-Hspec-Core-Example.html#line-77" class="link">Source</a> <a href="#t:Example" class="selflink">#</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div id="section.i:ic:Example:Example:1" class="inst-details hide"><div class="subs associated-types"><p class="caption">Associated Types</p><p class="src"><span class="keyword">type</span> <a href="Test-Hspec-Core-Spec.html#t:Arg">Arg</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Bool.html#t:Bool">Bool</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Kind.html#t:-42-">*</a> <a href="src/Test-Hspec-Core-Example.html#Arg" class="link">Source</a> <a href="#t:Arg" class="selflink">#</a></p></div> <div class="subs methods"><p class="caption">Methods</p><p class="src"><a href="#v:evaluateExample">evaluateExample</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Bool.html#t:Bool">Bool</a> -> <a href="Test-Hspec-Core-Spec.html#t:Params">Params</a> -> (<a href="Test-Hspec-Core-Spec.html#t:ActionWith">ActionWith</a> (<a href="Test-Hspec-Core-Spec.html#t:Arg">Arg</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Bool.html#t:Bool">Bool</a>) -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/System-IO.html#t:IO">IO</a> ()) -> <a href="Test-Hspec-Core-Spec.html#t:ProgressCallback">ProgressCallback</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/System-IO.html#t:IO">IO</a> <a href="Test-Hspec-Core-Spec.html#t:Result">Result</a> <a href="src/Test-Hspec-Core-Example.html#evaluateExample" class="link">Source</a> <a href="#v:evaluateExample" class="selflink">#</a></p></div></div></td></tr><tr><td class="src clearfix"><span class="inst-left"><span id="control.i:ic:Example:Example:2" class="instance expander" onclick="toggleSection('i:ic:Example:Example:2')"></span> <a href="Test-Hspec-Core-Spec.html#t:Example">Example</a> <a href="file:///usr/share/doc/libghc-quickcheck2-doc/html/Test-QuickCheck-Property.html#t:Property">Property</a></span> <a href="src/Test-Hspec-Core-Example.html#line-108" class="link">Source</a> <a href="#t:Example" class="selflink">#</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div id="section.i:ic:Example:Example:2" class="inst-details hide"><div class="subs associated-types"><p class="caption">Associated Types</p><p class="src"><span class="keyword">type</span> <a href="Test-Hspec-Core-Spec.html#t:Arg">Arg</a> <a href="file:///usr/share/doc/libghc-quickcheck2-doc/html/Test-QuickCheck-Property.html#t:Property">Property</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Kind.html#t:-42-">*</a> <a href="src/Test-Hspec-Core-Example.html#Arg" class="link">Source</a> <a href="#t:Arg" class="selflink">#</a></p></div> <div class="subs methods"><p class="caption">Methods</p><p class="src"><a href="#v:evaluateExample">evaluateExample</a> :: <a href="file:///usr/share/doc/libghc-quickcheck2-doc/html/Test-QuickCheck-Property.html#t:Property">Property</a> -> <a href="Test-Hspec-Core-Spec.html#t:Params">Params</a> -> (<a href="Test-Hspec-Core-Spec.html#t:ActionWith">ActionWith</a> (<a href="Test-Hspec-Core-Spec.html#t:Arg">Arg</a> <a href="file:///usr/share/doc/libghc-quickcheck2-doc/html/Test-QuickCheck-Property.html#t:Property">Property</a>) -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/System-IO.html#t:IO">IO</a> ()) -> <a href="Test-Hspec-Core-Spec.html#t:ProgressCallback">ProgressCallback</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/System-IO.html#t:IO">IO</a> <a href="Test-Hspec-Core-Spec.html#t:Result">Result</a> <a href="src/Test-Hspec-Core-Example.html#evaluateExample" class="link">Source</a> <a href="#v:evaluateExample" class="selflink">#</a></p></div></div></td></tr><tr><td class="src clearfix"><span class="inst-left"><span id="control.i:ic:Example:Example:3" class="instance expander" onclick="toggleSection('i:ic:Example:Example:3')"></span> <a href="Test-Hspec-Core-Spec.html#t:Example">Example</a> <a href="file:///usr/share/doc/libghc-hspec-expectations-doc/html/Test-Hspec-Expectations.html#t:Expectation">Expectation</a></span> <a href="src/Test-Hspec-Core-Example.html#line-81" class="link">Source</a> <a href="#t:Example" class="selflink">#</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div id="section.i:ic:Example:Example:3" class="inst-details hide"><div class="subs associated-types"><p class="caption">Associated Types</p><p class="src"><span class="keyword">type</span> <a href="Test-Hspec-Core-Spec.html#t:Arg">Arg</a> <a href="file:///usr/share/doc/libghc-hspec-expectations-doc/html/Test-Hspec-Expectations.html#t:Expectation">Expectation</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Kind.html#t:-42-">*</a> <a href="src/Test-Hspec-Core-Example.html#Arg" class="link">Source</a> <a href="#t:Arg" class="selflink">#</a></p></div> <div class="subs methods"><p class="caption">Methods</p><p class="src"><a href="#v:evaluateExample">evaluateExample</a> :: <a href="file:///usr/share/doc/libghc-hspec-expectations-doc/html/Test-Hspec-Expectations.html#t:Expectation">Expectation</a> -> <a href="Test-Hspec-Core-Spec.html#t:Params">Params</a> -> (<a href="Test-Hspec-Core-Spec.html#t:ActionWith">ActionWith</a> (<a href="Test-Hspec-Core-Spec.html#t:Arg">Arg</a> <a href="file:///usr/share/doc/libghc-hspec-expectations-doc/html/Test-Hspec-Expectations.html#t:Expectation">Expectation</a>) -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/System-IO.html#t:IO">IO</a> ()) -> <a href="Test-Hspec-Core-Spec.html#t:ProgressCallback">ProgressCallback</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/System-IO.html#t:IO">IO</a> <a href="Test-Hspec-Core-Spec.html#t:Result">Result</a> <a href="src/Test-Hspec-Core-Example.html#evaluateExample" class="link">Source</a> <a href="#v:evaluateExample" class="selflink">#</a></p></div></div></td></tr><tr><td class="src clearfix"><span class="inst-left"><span id="control.i:ic:Example:Example:4" class="instance expander" onclick="toggleSection('i:ic:Example:Example:4')"></span> <a href="Test-Hspec-Core-Spec.html#t:Example">Example</a> <a href="Test-Hspec-Core-Spec.html#t:Result">Result</a></span> <a href="src/Test-Hspec-Core-Example.html#line-104" class="link">Source</a> <a href="#t:Example" class="selflink">#</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div id="section.i:ic:Example:Example:4" class="inst-details hide"><div class="subs associated-types"><p class="caption">Associated Types</p><p class="src"><span class="keyword">type</span> <a href="Test-Hspec-Core-Spec.html#t:Arg">Arg</a> <a href="Test-Hspec-Core-Spec.html#t:Result">Result</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Kind.html#t:-42-">*</a> <a href="src/Test-Hspec-Core-Example.html#Arg" class="link">Source</a> <a href="#t:Arg" class="selflink">#</a></p></div> <div class="subs methods"><p class="caption">Methods</p><p class="src"><a href="#v:evaluateExample">evaluateExample</a> :: <a href="Test-Hspec-Core-Spec.html#t:Result">Result</a> -> <a href="Test-Hspec-Core-Spec.html#t:Params">Params</a> -> (<a href="Test-Hspec-Core-Spec.html#t:ActionWith">ActionWith</a> (<a href="Test-Hspec-Core-Spec.html#t:Arg">Arg</a> <a href="Test-Hspec-Core-Spec.html#t:Result">Result</a>) -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/System-IO.html#t:IO">IO</a> ()) -> <a href="Test-Hspec-Core-Spec.html#t:ProgressCallback">ProgressCallback</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/System-IO.html#t:IO">IO</a> <a href="Test-Hspec-Core-Spec.html#t:Result">Result</a> <a href="src/Test-Hspec-Core-Example.html#evaluateExample" class="link">Source</a> <a href="#v:evaluateExample" class="selflink">#</a></p></div></div></td></tr><tr><td class="src clearfix"><span class="inst-left"><span id="control.i:ic:Example:Example:5" class="instance expander" onclick="toggleSection('i:ic:Example:Example:5')"></span> <a href="Test-Hspec-Core-Spec.html#t:Example">Example</a> (a -> <a href="file:///usr/share/doc/libghc-quickcheck2-doc/html/Test-QuickCheck-Property.html#t:Property">Property</a>)</span> <a href="src/Test-Hspec-Core-Example.html#line-112" class="link">Source</a> <a href="#t:Example" class="selflink">#</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div id="section.i:ic:Example:Example:5" class="inst-details hide"><div class="subs associated-types"><p class="caption">Associated Types</p><p class="src"><span class="keyword">type</span> <a href="Test-Hspec-Core-Spec.html#t:Arg">Arg</a> (a -> <a href="file:///usr/share/doc/libghc-quickcheck2-doc/html/Test-QuickCheck-Property.html#t:Property">Property</a>) :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Kind.html#t:-42-">*</a> <a href="src/Test-Hspec-Core-Example.html#Arg" class="link">Source</a> <a href="#t:Arg" class="selflink">#</a></p></div> <div class="subs methods"><p class="caption">Methods</p><p class="src"><a href="#v:evaluateExample">evaluateExample</a> :: (a -> <a href="file:///usr/share/doc/libghc-quickcheck2-doc/html/Test-QuickCheck-Property.html#t:Property">Property</a>) -> <a href="Test-Hspec-Core-Spec.html#t:Params">Params</a> -> (<a href="Test-Hspec-Core-Spec.html#t:ActionWith">ActionWith</a> (<a href="Test-Hspec-Core-Spec.html#t:Arg">Arg</a> (a -> <a href="file:///usr/share/doc/libghc-quickcheck2-doc/html/Test-QuickCheck-Property.html#t:Property">Property</a>)) -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/System-IO.html#t:IO">IO</a> ()) -> <a href="Test-Hspec-Core-Spec.html#t:ProgressCallback">ProgressCallback</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/System-IO.html#t:IO">IO</a> <a href="Test-Hspec-Core-Spec.html#t:Result">Result</a> <a href="src/Test-Hspec-Core-Example.html#evaluateExample" class="link">Source</a> <a href="#v:evaluateExample" class="selflink">#</a></p></div></div></td></tr><tr><td class="src clearfix"><span class="inst-left"><span id="control.i:ic:Example:Example:6" class="instance expander" onclick="toggleSection('i:ic:Example:Example:6')"></span> <a href="Test-Hspec-Core-Spec.html#t:Example">Example</a> (a -> <a href="file:///usr/share/doc/libghc-hspec-expectations-doc/html/Test-Hspec-Expectations.html#t:Expectation">Expectation</a>)</span> <a href="src/Test-Hspec-Core-Example.html#line-97" class="link">Source</a> <a href="#t:Example" class="selflink">#</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div id="section.i:ic:Example:Example:6" class="inst-details hide"><div class="subs associated-types"><p class="caption">Associated Types</p><p class="src"><span class="keyword">type</span> <a href="Test-Hspec-Core-Spec.html#t:Arg">Arg</a> (a -> <a href="file:///usr/share/doc/libghc-hspec-expectations-doc/html/Test-Hspec-Expectations.html#t:Expectation">Expectation</a>) :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Kind.html#t:-42-">*</a> <a href="src/Test-Hspec-Core-Example.html#Arg" class="link">Source</a> <a href="#t:Arg" class="selflink">#</a></p></div> <div class="subs methods"><p class="caption">Methods</p><p class="src"><a href="#v:evaluateExample">evaluateExample</a> :: (a -> <a href="file:///usr/share/doc/libghc-hspec-expectations-doc/html/Test-Hspec-Expectations.html#t:Expectation">Expectation</a>) -> <a href="Test-Hspec-Core-Spec.html#t:Params">Params</a> -> (<a href="Test-Hspec-Core-Spec.html#t:ActionWith">ActionWith</a> (<a href="Test-Hspec-Core-Spec.html#t:Arg">Arg</a> (a -> <a href="file:///usr/share/doc/libghc-hspec-expectations-doc/html/Test-Hspec-Expectations.html#t:Expectation">Expectation</a>)) -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/System-IO.html#t:IO">IO</a> ()) -> <a href="Test-Hspec-Core-Spec.html#t:ProgressCallback">ProgressCallback</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/System-IO.html#t:IO">IO</a> <a href="Test-Hspec-Core-Spec.html#t:Result">Result</a> <a href="src/Test-Hspec-Core-Example.html#evaluateExample" class="link">Source</a> <a href="#v:evaluateExample" class="selflink">#</a></p></div></div></td></tr></table></div></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a id="t:Params" class="def">Params</a> <a href="src/Test-Hspec-Core-Example.html#Params" class="link">Source</a> <a href="#t:Params" class="selflink">#</a></p><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a id="v:Params" class="def">Params</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div class="subs fields"><p class="caption">Fields</p><ul><li><dfn class="src"><a id="v:paramsQuickCheckArgs" class="def">paramsQuickCheckArgs</a> :: <a href="file:///usr/share/doc/libghc-quickcheck2-doc/html/Test-QuickCheck-Test.html#t:Args">Args</a></dfn><div class="doc empty"> </div></li><li><dfn class="src"><a id="v:paramsSmallCheckDepth" class="def">paramsSmallCheckDepth</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Int.html#t:Int">Int</a></dfn><div class="doc empty"> </div></li></ul></div></td></tr></table></div><div class="subs instances"><p id="control.i:Params" class="caption collapser" onclick="toggleSection('i:Params')">Instances</p><div id="section.i:Params" class="show"><table><tr><td class="src clearfix"><span class="inst-left"><span id="control.i:id:Params:Show:1" class="instance expander" onclick="toggleSection('i:id:Params:Show:1')"></span> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Text-Show.html#t:Show">Show</a> <a href="Test-Hspec-Core-Spec.html#t:Params">Params</a></span> <a href="src/Test-Hspec-Core-Example.html#line-40" class="link">Source</a> <a href="#t:Params" class="selflink">#</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div id="section.i:id:Params:Show:1" class="inst-details hide"><div class="subs methods"><p class="caption">Methods</p><p class="src"><a href="#v:showsPrec">showsPrec</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Int.html#t:Int">Int</a> -> <a href="Test-Hspec-Core-Spec.html#t:Params">Params</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Text-Show.html#t:ShowS">ShowS</a> <a href="#v:showsPrec" class="selflink">#</a></p><p class="src"><a href="#v:show">show</a> :: <a href="Test-Hspec-Core-Spec.html#t:Params">Params</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-String.html#t:String">String</a> <a href="#v:show" class="selflink">#</a></p><p class="src"><a href="#v:showList">showList</a> :: [<a href="Test-Hspec-Core-Spec.html#t:Params">Params</a>] -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Text-Show.html#t:ShowS">ShowS</a> <a href="#v:showList" class="selflink">#</a></p></div></div></td></tr></table></div></div></div><div class="top"><p class="src"><a id="v:defaultParams" class="def">defaultParams</a> :: <a href="Test-Hspec-Core-Spec.html#t:Params">Params</a> <a href="src/Test-Hspec-Core-Example.html#defaultParams" class="link">Source</a> <a href="#v:defaultParams" class="selflink">#</a></p></div><div class="top"><p class="src"><span class="keyword">type</span> <a id="t:ActionWith" class="def">ActionWith</a> a = a -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/System-IO.html#t:IO">IO</a> () <a href="src/Test-Hspec-Core-Example.html#ActionWith" class="link">Source</a> <a href="#t:ActionWith" class="selflink">#</a></p><div class="doc"><p>An <code><a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/System-IO.html#t:IO">IO</a></code> action that expects an argument of type <code>a</code></p></div></div><div class="top"><p class="src"><span class="keyword">type</span> <a id="t:Progress" class="def">Progress</a> = (<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Int.html#t:Int">Int</a>, <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Int.html#t:Int">Int</a>) <a href="src/Test-Hspec-Core-Example.html#Progress" class="link">Source</a> <a href="#t:Progress" class="selflink">#</a></p></div><div class="top"><p class="src"><span class="keyword">type</span> <a id="t:ProgressCallback" class="def">ProgressCallback</a> = <a href="Test-Hspec-Core-Spec.html#t:Progress">Progress</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/System-IO.html#t:IO">IO</a> () <a href="src/Test-Hspec-Core-Example.html#ProgressCallback" class="link">Source</a> <a href="#t:ProgressCallback" class="selflink">#</a></p></div><div class="top"><p class="src"><span class="keyword">data</span> <a id="t:Result" class="def">Result</a> <a href="src/Test-Hspec-Core-Example.html#Result" class="link">Source</a> <a href="#t:Result" class="selflink">#</a></p><div class="doc"><p>The result of running an example</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a id="v:Success" class="def">Success</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a id="v:Pending" class="def">Pending</a> (<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-String.html#t:String">String</a>)</td><td class="doc empty"> </td></tr><tr><td class="src"><a id="v:Fail" class="def">Fail</a> (<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Test-Hspec-Core-Spec.html#t:Location">Location</a>) <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-String.html#t:String">String</a></td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:Result" class="caption collapser" onclick="toggleSection('i:Result')">Instances</p><div id="section.i:Result" class="show"><table><tr><td class="src clearfix"><span class="inst-left"><span id="control.i:id:Result:Eq:1" class="instance expander" onclick="toggleSection('i:id:Result:Eq:1')"></span> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Eq.html#t:Eq">Eq</a> <a href="Test-Hspec-Core-Spec.html#t:Result">Result</a></span> <a href="src/Test-Hspec-Core-Example.html#line-56" class="link">Source</a> <a href="#t:Result" class="selflink">#</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div id="section.i:id:Result:Eq:1" class="inst-details hide"><div class="subs methods"><p class="caption">Methods</p><p class="src"><a href="#v:-61--61-">(==)</a> :: <a href="Test-Hspec-Core-Spec.html#t:Result">Result</a> -> <a href="Test-Hspec-Core-Spec.html#t:Result">Result</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Bool.html#t:Bool">Bool</a> <a href="#v:-61--61-" class="selflink">#</a></p><p class="src"><a href="#v:-47--61-">(/=)</a> :: <a href="Test-Hspec-Core-Spec.html#t:Result">Result</a> -> <a href="Test-Hspec-Core-Spec.html#t:Result">Result</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Bool.html#t:Bool">Bool</a> <a href="#v:-47--61-" class="selflink">#</a></p></div></div></td></tr><tr><td class="src clearfix"><span class="inst-left"><span id="control.i:id:Result:Read:2" class="instance expander" onclick="toggleSection('i:id:Result:Read:2')"></span> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Text-Read.html#t:Read">Read</a> <a href="Test-Hspec-Core-Spec.html#t:Result">Result</a></span> <a href="src/Test-Hspec-Core-Example.html#line-56" class="link">Source</a> <a href="#t:Result" class="selflink">#</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div id="section.i:id:Result:Read:2" class="inst-details hide"><div class="subs methods"><p class="caption">Methods</p><p class="src"><a href="#v:readsPrec">readsPrec</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Int.html#t:Int">Int</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Text-ParserCombinators-ReadP.html#t:ReadS">ReadS</a> <a href="Test-Hspec-Core-Spec.html#t:Result">Result</a> <a href="#v:readsPrec" class="selflink">#</a></p><p class="src"><a href="#v:readList">readList</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Text-ParserCombinators-ReadP.html#t:ReadS">ReadS</a> [<a href="Test-Hspec-Core-Spec.html#t:Result">Result</a>] <a href="#v:readList" class="selflink">#</a></p><p class="src"><a href="#v:readPrec">readPrec</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Text-ParserCombinators-ReadPrec.html#t:ReadPrec">ReadPrec</a> <a href="Test-Hspec-Core-Spec.html#t:Result">Result</a> <a href="#v:readPrec" class="selflink">#</a></p><p class="src"><a href="#v:readListPrec">readListPrec</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Text-ParserCombinators-ReadPrec.html#t:ReadPrec">ReadPrec</a> [<a href="Test-Hspec-Core-Spec.html#t:Result">Result</a>] <a href="#v:readListPrec" class="selflink">#</a></p></div></div></td></tr><tr><td class="src clearfix"><span class="inst-left"><span id="control.i:id:Result:Show:3" class="instance expander" onclick="toggleSection('i:id:Result:Show:3')"></span> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Text-Show.html#t:Show">Show</a> <a href="Test-Hspec-Core-Spec.html#t:Result">Result</a></span> <a href="src/Test-Hspec-Core-Example.html#line-56" class="link">Source</a> <a href="#t:Result" class="selflink">#</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div id="section.i:id:Result:Show:3" class="inst-details hide"><div class="subs methods"><p class="caption">Methods</p><p class="src"><a href="#v:showsPrec">showsPrec</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Int.html#t:Int">Int</a> -> <a href="Test-Hspec-Core-Spec.html#t:Result">Result</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Text-Show.html#t:ShowS">ShowS</a> <a href="#v:showsPrec" class="selflink">#</a></p><p class="src"><a href="#v:show">show</a> :: <a href="Test-Hspec-Core-Spec.html#t:Result">Result</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-String.html#t:String">String</a> <a href="#v:show" class="selflink">#</a></p><p class="src"><a href="#v:showList">showList</a> :: [<a href="Test-Hspec-Core-Spec.html#t:Result">Result</a>] -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Text-Show.html#t:ShowS">ShowS</a> <a href="#v:showList" class="selflink">#</a></p></div></div></td></tr><tr><td class="src clearfix"><span class="inst-left"><span id="control.i:id:Result:Exception:4" class="instance expander" onclick="toggleSection('i:id:Result:Exception:4')"></span> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Control-Exception-Base.html#t:Exception">Exception</a> <a href="Test-Hspec-Core-Spec.html#t:Result">Result</a></span> <a href="src/Test-Hspec-Core-Example.html#line-58" class="link">Source</a> <a href="#t:Result" class="selflink">#</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div id="section.i:id:Result:Exception:4" class="inst-details hide"><div class="subs methods"><p class="caption">Methods</p><p class="src"><a href="#v:toException">toException</a> :: <a href="Test-Hspec-Core-Spec.html#t:Result">Result</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Control-Exception-Base.html#t:SomeException">SomeException</a> <a href="#v:toException" class="selflink">#</a></p><p class="src"><a href="#v:fromException">fromException</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Control-Exception-Base.html#t:SomeException">SomeException</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Test-Hspec-Core-Spec.html#t:Result">Result</a> <a href="#v:fromException" class="selflink">#</a></p><p class="src"><a href="#v:displayException">displayException</a> :: <a href="Test-Hspec-Core-Spec.html#t:Result">Result</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-String.html#t:String">String</a> <a href="#v:displayException" class="selflink">#</a></p></div></div></td></tr><tr><td class="src clearfix"><span class="inst-left"><span id="control.i:id:Result:Example:5" class="instance expander" onclick="toggleSection('i:id:Result:Example:5')"></span> <a href="Test-Hspec-Core-Spec.html#t:Example">Example</a> <a href="Test-Hspec-Core-Spec.html#t:Result">Result</a></span> <a href="src/Test-Hspec-Core-Example.html#line-104" class="link">Source</a> <a href="#t:Result" class="selflink">#</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div id="section.i:id:Result:Example:5" class="inst-details hide"><div class="subs associated-types"><p class="caption">Associated Types</p><p class="src"><span class="keyword">type</span> <a href="Test-Hspec-Core-Spec.html#t:Arg">Arg</a> <a href="Test-Hspec-Core-Spec.html#t:Result">Result</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Kind.html#t:-42-">*</a> <a href="src/Test-Hspec-Core-Example.html#Arg" class="link">Source</a> <a href="#t:Arg" class="selflink">#</a></p></div> <div class="subs methods"><p class="caption">Methods</p><p class="src"><a href="#v:evaluateExample">evaluateExample</a> :: <a href="Test-Hspec-Core-Spec.html#t:Result">Result</a> -> <a href="Test-Hspec-Core-Spec.html#t:Params">Params</a> -> (<a href="Test-Hspec-Core-Spec.html#t:ActionWith">ActionWith</a> (<a href="Test-Hspec-Core-Spec.html#t:Arg">Arg</a> <a href="Test-Hspec-Core-Spec.html#t:Result">Result</a>) -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/System-IO.html#t:IO">IO</a> ()) -> <a href="Test-Hspec-Core-Spec.html#t:ProgressCallback">ProgressCallback</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/System-IO.html#t:IO">IO</a> <a href="Test-Hspec-Core-Spec.html#t:Result">Result</a> <a href="src/Test-Hspec-Core-Example.html#evaluateExample" class="link">Source</a> <a href="#v:evaluateExample" class="selflink">#</a></p></div></div></td></tr><tr><td class="src clearfix"><span class="inst-left"><span id="control.i:id:Result:Arg:6" class="instance expander" onclick="toggleSection('i:id:Result:Arg:6')"></span> <span class="keyword">type</span> <a href="Test-Hspec-Core-Spec.html#t:Arg">Arg</a> <a href="Test-Hspec-Core-Spec.html#t:Result">Result</a></span> <a href="src/Test-Hspec-Core-Example.html#line-105" class="link">Source</a> <a href="#t:Result" class="selflink">#</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div id="section.i:id:Result:Arg:6" class="inst-details hide"><div class="src"><span class="keyword">type</span> <a href="Test-Hspec-Core-Spec.html#t:Arg">Arg</a> <a href="Test-Hspec-Core-Spec.html#t:Result">Result</a> = ()</div></div></td></tr></table></div></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a id="t:Location" class="def">Location</a> <a href="src/Test-Hspec-Core-Example.html#Location" class="link">Source</a> <a href="#t:Location" class="selflink">#</a></p><div class="doc"><p><code>Location</code> is used to represent source locations.</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a id="v:Location" class="def">Location</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div class="subs fields"><p class="caption">Fields</p><ul><li><dfn class="src"><a id="v:locationFile" class="def">locationFile</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/System-IO.html#t:FilePath">FilePath</a></dfn><div class="doc empty"> </div></li><li><dfn class="src"><a id="v:locationLine" class="def">locationLine</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Int.html#t:Int">Int</a></dfn><div class="doc empty"> </div></li><li><dfn class="src"><a id="v:locationColumn" class="def">locationColumn</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Int.html#t:Int">Int</a></dfn><div class="doc empty"> </div></li><li><dfn class="src"><a id="v:locationAccuracy" class="def">locationAccuracy</a> :: <a href="Test-Hspec-Core-Spec.html#t:LocationAccuracy">LocationAccuracy</a></dfn><div class="doc empty"> </div></li></ul></div></td></tr></table></div><div class="subs instances"><p id="control.i:Location" class="caption collapser" onclick="toggleSection('i:Location')">Instances</p><div id="section.i:Location" class="show"><table><tr><td class="src clearfix"><span class="inst-left"><span id="control.i:id:Location:Eq:1" class="instance expander" onclick="toggleSection('i:id:Location:Eq:1')"></span> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Eq.html#t:Eq">Eq</a> <a href="Test-Hspec-Core-Spec.html#t:Location">Location</a></span> <a href="src/Test-Hspec-Core-Example.html#line-66" class="link">Source</a> <a href="#t:Location" class="selflink">#</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div id="section.i:id:Location:Eq:1" class="inst-details hide"><div class="subs methods"><p class="caption">Methods</p><p class="src"><a href="#v:-61--61-">(==)</a> :: <a href="Test-Hspec-Core-Spec.html#t:Location">Location</a> -> <a href="Test-Hspec-Core-Spec.html#t:Location">Location</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Bool.html#t:Bool">Bool</a> <a href="#v:-61--61-" class="selflink">#</a></p><p class="src"><a href="#v:-47--61-">(/=)</a> :: <a href="Test-Hspec-Core-Spec.html#t:Location">Location</a> -> <a href="Test-Hspec-Core-Spec.html#t:Location">Location</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Bool.html#t:Bool">Bool</a> <a href="#v:-47--61-" class="selflink">#</a></p></div></div></td></tr><tr><td class="src clearfix"><span class="inst-left"><span id="control.i:id:Location:Read:2" class="instance expander" onclick="toggleSection('i:id:Location:Read:2')"></span> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Text-Read.html#t:Read">Read</a> <a href="Test-Hspec-Core-Spec.html#t:Location">Location</a></span> <a href="src/Test-Hspec-Core-Example.html#line-66" class="link">Source</a> <a href="#t:Location" class="selflink">#</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div id="section.i:id:Location:Read:2" class="inst-details hide"><div class="subs methods"><p class="caption">Methods</p><p class="src"><a href="#v:readsPrec">readsPrec</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Int.html#t:Int">Int</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Text-ParserCombinators-ReadP.html#t:ReadS">ReadS</a> <a href="Test-Hspec-Core-Spec.html#t:Location">Location</a> <a href="#v:readsPrec" class="selflink">#</a></p><p class="src"><a href="#v:readList">readList</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Text-ParserCombinators-ReadP.html#t:ReadS">ReadS</a> [<a href="Test-Hspec-Core-Spec.html#t:Location">Location</a>] <a href="#v:readList" class="selflink">#</a></p><p class="src"><a href="#v:readPrec">readPrec</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Text-ParserCombinators-ReadPrec.html#t:ReadPrec">ReadPrec</a> <a href="Test-Hspec-Core-Spec.html#t:Location">Location</a> <a href="#v:readPrec" class="selflink">#</a></p><p class="src"><a href="#v:readListPrec">readListPrec</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Text-ParserCombinators-ReadPrec.html#t:ReadPrec">ReadPrec</a> [<a href="Test-Hspec-Core-Spec.html#t:Location">Location</a>] <a href="#v:readListPrec" class="selflink">#</a></p></div></div></td></tr><tr><td class="src clearfix"><span class="inst-left"><span id="control.i:id:Location:Show:3" class="instance expander" onclick="toggleSection('i:id:Location:Show:3')"></span> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Text-Show.html#t:Show">Show</a> <a href="Test-Hspec-Core-Spec.html#t:Location">Location</a></span> <a href="src/Test-Hspec-Core-Example.html#line-66" class="link">Source</a> <a href="#t:Location" class="selflink">#</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div id="section.i:id:Location:Show:3" class="inst-details hide"><div class="subs methods"><p class="caption">Methods</p><p class="src"><a href="#v:showsPrec">showsPrec</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Int.html#t:Int">Int</a> -> <a href="Test-Hspec-Core-Spec.html#t:Location">Location</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Text-Show.html#t:ShowS">ShowS</a> <a href="#v:showsPrec" class="selflink">#</a></p><p class="src"><a href="#v:show">show</a> :: <a href="Test-Hspec-Core-Spec.html#t:Location">Location</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-String.html#t:String">String</a> <a href="#v:show" class="selflink">#</a></p><p class="src"><a href="#v:showList">showList</a> :: [<a href="Test-Hspec-Core-Spec.html#t:Location">Location</a>] -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Text-Show.html#t:ShowS">ShowS</a> <a href="#v:showList" class="selflink">#</a></p></div></div></td></tr></table></div></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a id="t:LocationAccuracy" class="def">LocationAccuracy</a> <a href="src/Test-Hspec-Core-Example.html#LocationAccuracy" class="link">Source</a> <a href="#t:LocationAccuracy" class="selflink">#</a></p><div class="doc"><p>A marker for source locations</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a id="v:ExactLocation" class="def">ExactLocation</a></td><td class="doc"><p>The source location is accurate</p></td></tr><tr><td class="src"><a id="v:BestEffort" class="def">BestEffort</a></td><td class="doc"><p>The source location was determined on a best-effort basis and my be
wrong or inaccurate</p></td></tr></table></div><div class="subs instances"><p id="control.i:LocationAccuracy" class="caption collapser" onclick="toggleSection('i:LocationAccuracy')">Instances</p><div id="section.i:LocationAccuracy" class="show"><table><tr><td class="src clearfix"><span class="inst-left"><span id="control.i:id:LocationAccuracy:Eq:1" class="instance expander" onclick="toggleSection('i:id:LocationAccuracy:Eq:1')"></span> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Eq.html#t:Eq">Eq</a> <a href="Test-Hspec-Core-Spec.html#t:LocationAccuracy">LocationAccuracy</a></span> <a href="src/Test-Hspec-Core-Example.html#line-75" class="link">Source</a> <a href="#t:LocationAccuracy" class="selflink">#</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div id="section.i:id:LocationAccuracy:Eq:1" class="inst-details hide"><div class="subs methods"><p class="caption">Methods</p><p class="src"><a href="#v:-61--61-">(==)</a> :: <a href="Test-Hspec-Core-Spec.html#t:LocationAccuracy">LocationAccuracy</a> -> <a href="Test-Hspec-Core-Spec.html#t:LocationAccuracy">LocationAccuracy</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Bool.html#t:Bool">Bool</a> <a href="#v:-61--61-" class="selflink">#</a></p><p class="src"><a href="#v:-47--61-">(/=)</a> :: <a href="Test-Hspec-Core-Spec.html#t:LocationAccuracy">LocationAccuracy</a> -> <a href="Test-Hspec-Core-Spec.html#t:LocationAccuracy">LocationAccuracy</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Bool.html#t:Bool">Bool</a> <a href="#v:-47--61-" class="selflink">#</a></p></div></div></td></tr><tr><td class="src clearfix"><span class="inst-left"><span id="control.i:id:LocationAccuracy:Read:2" class="instance expander" onclick="toggleSection('i:id:LocationAccuracy:Read:2')"></span> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Text-Read.html#t:Read">Read</a> <a href="Test-Hspec-Core-Spec.html#t:LocationAccuracy">LocationAccuracy</a></span> <a href="src/Test-Hspec-Core-Example.html#line-75" class="link">Source</a> <a href="#t:LocationAccuracy" class="selflink">#</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div id="section.i:id:LocationAccuracy:Read:2" class="inst-details hide"><div class="subs methods"><p class="caption">Methods</p><p class="src"><a href="#v:readsPrec">readsPrec</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Int.html#t:Int">Int</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Text-ParserCombinators-ReadP.html#t:ReadS">ReadS</a> <a href="Test-Hspec-Core-Spec.html#t:LocationAccuracy">LocationAccuracy</a> <a href="#v:readsPrec" class="selflink">#</a></p><p class="src"><a href="#v:readList">readList</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Text-ParserCombinators-ReadP.html#t:ReadS">ReadS</a> [<a href="Test-Hspec-Core-Spec.html#t:LocationAccuracy">LocationAccuracy</a>] <a href="#v:readList" class="selflink">#</a></p><p class="src"><a href="#v:readPrec">readPrec</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Text-ParserCombinators-ReadPrec.html#t:ReadPrec">ReadPrec</a> <a href="Test-Hspec-Core-Spec.html#t:LocationAccuracy">LocationAccuracy</a> <a href="#v:readPrec" class="selflink">#</a></p><p class="src"><a href="#v:readListPrec">readListPrec</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Text-ParserCombinators-ReadPrec.html#t:ReadPrec">ReadPrec</a> [<a href="Test-Hspec-Core-Spec.html#t:LocationAccuracy">LocationAccuracy</a>] <a href="#v:readListPrec" class="selflink">#</a></p></div></div></td></tr><tr><td class="src clearfix"><span class="inst-left"><span id="control.i:id:LocationAccuracy:Show:3" class="instance expander" onclick="toggleSection('i:id:LocationAccuracy:Show:3')"></span> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Text-Show.html#t:Show">Show</a> <a href="Test-Hspec-Core-Spec.html#t:LocationAccuracy">LocationAccuracy</a></span> <a href="src/Test-Hspec-Core-Example.html#line-75" class="link">Source</a> <a href="#t:LocationAccuracy" class="selflink">#</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div id="section.i:id:LocationAccuracy:Show:3" class="inst-details hide"><div class="subs methods"><p class="caption">Methods</p><p class="src"><a href="#v:showsPrec">showsPrec</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Int.html#t:Int">Int</a> -> <a href="Test-Hspec-Core-Spec.html#t:LocationAccuracy">LocationAccuracy</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Text-Show.html#t:ShowS">ShowS</a> <a href="#v:showsPrec" class="selflink">#</a></p><p class="src"><a href="#v:show">show</a> :: <a href="Test-Hspec-Core-Spec.html#t:LocationAccuracy">LocationAccuracy</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-String.html#t:String">String</a> <a href="#v:show" class="selflink">#</a></p><p class="src"><a href="#v:showList">showList</a> :: [<a href="Test-Hspec-Core-Spec.html#t:LocationAccuracy">LocationAccuracy</a>] -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Text-Show.html#t:ShowS">ShowS</a> <a href="#v:showList" class="selflink">#</a></p></div></div></td></tr></table></div></div></div><h1 id="g:4">Internal representation of a spec tree</h1><div class="top"><p class="src"><span class="keyword">type</span> <a id="t:SpecTree" class="def">SpecTree</a> a = <a href="Test-Hspec-Core-Spec.html#t:Tree">Tree</a> (<a href="Test-Hspec-Core-Spec.html#t:ActionWith">ActionWith</a> a) (<a href="Test-Hspec-Core-Spec.html#t:Item">Item</a> a) <a href="src/Test-Hspec-Core-Tree.html#SpecTree" class="link">Source</a> <a href="#t:SpecTree" class="selflink">#</a></p><div class="doc"><p>A tree is used to represent a spec internally. The tree is parametrize
over the type of cleanup actions and the type of the actual spec items.</p></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a id="t:Tree" class="def">Tree</a> c a <a href="src/Test-Hspec-Core-Tree.html#Tree" class="link">Source</a> <a href="#t:Tree" class="selflink">#</a></p><div class="doc"><p>Internal tree data structure</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a id="v:Node" class="def">Node</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-String.html#t:String">String</a> [<a href="Test-Hspec-Core-Spec.html#t:Tree">Tree</a> c a]</td><td class="doc empty"> </td></tr><tr><td class="src"><a id="v:NodeWithCleanup" class="def">NodeWithCleanup</a> c [<a href="Test-Hspec-Core-Spec.html#t:Tree">Tree</a> c a]</td><td class="doc empty"> </td></tr><tr><td class="src"><a id="v:Leaf" class="def">Leaf</a> a</td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:Tree" class="caption collapser" onclick="toggleSection('i:Tree')">Instances</p><div id="section.i:Tree" class="show"><table><tr><td class="src clearfix"><span class="inst-left"><span id="control.i:id:Tree:Functor:1" class="instance expander" onclick="toggleSection('i:id:Tree:Functor:1')"></span> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Functor.html#t:Functor">Functor</a> (<a href="Test-Hspec-Core-Spec.html#t:Tree">Tree</a> c)</span> <a href="src/Test-Hspec-Core-Tree.html#line-36" class="link">Source</a> <a href="#t:Tree" class="selflink">#</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div id="section.i:id:Tree:Functor:1" class="inst-details hide"><div class="subs methods"><p class="caption">Methods</p><p class="src"><a href="#v:fmap">fmap</a> :: (a -> b) -> <a href="Test-Hspec-Core-Spec.html#t:Tree">Tree</a> c a -> <a href="Test-Hspec-Core-Spec.html#t:Tree">Tree</a> c b <a href="#v:fmap" class="selflink">#</a></p><p class="src"><a href="#v:-60--36-">(<$)</a> :: a -> <a href="Test-Hspec-Core-Spec.html#t:Tree">Tree</a> c b -> <a href="Test-Hspec-Core-Spec.html#t:Tree">Tree</a> c a <a href="#v:-60--36-" class="selflink">#</a></p></div></div></td></tr><tr><td class="src clearfix"><span class="inst-left"><span id="control.i:id:Tree:Foldable:2" class="instance expander" onclick="toggleSection('i:id:Tree:Foldable:2')"></span> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Foldable.html#t:Foldable">Foldable</a> (<a href="Test-Hspec-Core-Spec.html#t:Tree">Tree</a> c)</span> <a href="src/Test-Hspec-Core-Tree.html#line-38" class="link">Source</a> <a href="#t:Tree" class="selflink">#</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div id="section.i:id:Tree:Foldable:2" class="inst-details hide"><div class="subs methods"><p class="caption">Methods</p><p class="src"><a href="#v:fold">fold</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Monoid.html#t:Monoid">Monoid</a> m => <a href="Test-Hspec-Core-Spec.html#t:Tree">Tree</a> c m -> m <a href="#v:fold" class="selflink">#</a></p><p class="src"><a href="#v:foldMap">foldMap</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Monoid.html#t:Monoid">Monoid</a> m => (a -> m) -> <a href="Test-Hspec-Core-Spec.html#t:Tree">Tree</a> c a -> m <a href="#v:foldMap" class="selflink">#</a></p><p class="src"><a href="#v:foldr">foldr</a> :: (a -> b -> b) -> b -> <a href="Test-Hspec-Core-Spec.html#t:Tree">Tree</a> c a -> b <a href="#v:foldr" class="selflink">#</a></p><p class="src"><a href="#v:foldr-39-">foldr'</a> :: (a -> b -> b) -> b -> <a href="Test-Hspec-Core-Spec.html#t:Tree">Tree</a> c a -> b <a href="#v:foldr-39-" class="selflink">#</a></p><p class="src"><a href="#v:foldl">foldl</a> :: (b -> a -> b) -> b -> <a href="Test-Hspec-Core-Spec.html#t:Tree">Tree</a> c a -> b <a href="#v:foldl" class="selflink">#</a></p><p class="src"><a href="#v:foldl-39-">foldl'</a> :: (b -> a -> b) -> b -> <a href="Test-Hspec-Core-Spec.html#t:Tree">Tree</a> c a -> b <a href="#v:foldl-39-" class="selflink">#</a></p><p class="src"><a href="#v:foldr1">foldr1</a> :: (a -> a -> a) -> <a href="Test-Hspec-Core-Spec.html#t:Tree">Tree</a> c a -> a <a href="#v:foldr1" class="selflink">#</a></p><p class="src"><a href="#v:foldl1">foldl1</a> :: (a -> a -> a) -> <a href="Test-Hspec-Core-Spec.html#t:Tree">Tree</a> c a -> a <a href="#v:foldl1" class="selflink">#</a></p><p class="src"><a href="#v:toList">toList</a> :: <a href="Test-Hspec-Core-Spec.html#t:Tree">Tree</a> c a -> [a] <a href="#v:toList" class="selflink">#</a></p><p class="src"><a href="#v:null">null</a> :: <a href="Test-Hspec-Core-Spec.html#t:Tree">Tree</a> c a -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Bool.html#t:Bool">Bool</a> <a href="#v:null" class="selflink">#</a></p><p class="src"><a href="#v:length">length</a> :: <a href="Test-Hspec-Core-Spec.html#t:Tree">Tree</a> c a -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Int.html#t:Int">Int</a> <a href="#v:length" class="selflink">#</a></p><p class="src"><a href="#v:elem">elem</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Eq.html#t:Eq">Eq</a> a => a -> <a href="Test-Hspec-Core-Spec.html#t:Tree">Tree</a> c a -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Bool.html#t:Bool">Bool</a> <a href="#v:elem" class="selflink">#</a></p><p class="src"><a href="#v:maximum">maximum</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Ord.html#t:Ord">Ord</a> a => <a href="Test-Hspec-Core-Spec.html#t:Tree">Tree</a> c a -> a <a href="#v:maximum" class="selflink">#</a></p><p class="src"><a href="#v:minimum">minimum</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Ord.html#t:Ord">Ord</a> a => <a href="Test-Hspec-Core-Spec.html#t:Tree">Tree</a> c a -> a <a href="#v:minimum" class="selflink">#</a></p><p class="src"><a href="#v:sum">sum</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Prelude.html#t:Num">Num</a> a => <a href="Test-Hspec-Core-Spec.html#t:Tree">Tree</a> c a -> a <a href="#v:sum" class="selflink">#</a></p><p class="src"><a href="#v:product">product</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Prelude.html#t:Num">Num</a> a => <a href="Test-Hspec-Core-Spec.html#t:Tree">Tree</a> c a -> a <a href="#v:product" class="selflink">#</a></p></div></div></td></tr><tr><td class="src clearfix"><span class="inst-left"><span id="control.i:id:Tree:Traversable:3" class="instance expander" onclick="toggleSection('i:id:Tree:Traversable:3')"></span> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Traversable.html#t:Traversable">Traversable</a> (<a href="Test-Hspec-Core-Spec.html#t:Tree">Tree</a> c)</span> <a href="src/Test-Hspec-Core-Tree.html#line-47" class="link">Source</a> <a href="#t:Tree" class="selflink">#</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div id="section.i:id:Tree:Traversable:3" class="inst-details hide"><div class="subs methods"><p class="caption">Methods</p><p class="src"><a href="#v:traverse">traverse</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Control-Applicative.html#t:Applicative">Applicative</a> f => (a -> f b) -> <a href="Test-Hspec-Core-Spec.html#t:Tree">Tree</a> c a -> f (<a href="Test-Hspec-Core-Spec.html#t:Tree">Tree</a> c b) <a href="#v:traverse" class="selflink">#</a></p><p class="src"><a href="#v:sequenceA">sequenceA</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Control-Applicative.html#t:Applicative">Applicative</a> f => <a href="Test-Hspec-Core-Spec.html#t:Tree">Tree</a> c (f a) -> f (<a href="Test-Hspec-Core-Spec.html#t:Tree">Tree</a> c a) <a href="#v:sequenceA" class="selflink">#</a></p><p class="src"><a href="#v:mapM">mapM</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Control-Monad.html#t:Monad">Monad</a> m => (a -> m b) -> <a href="Test-Hspec-Core-Spec.html#t:Tree">Tree</a> c a -> m (<a href="Test-Hspec-Core-Spec.html#t:Tree">Tree</a> c b) <a href="#v:mapM" class="selflink">#</a></p><p class="src"><a href="#v:sequence">sequence</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Control-Monad.html#t:Monad">Monad</a> m => <a href="Test-Hspec-Core-Spec.html#t:Tree">Tree</a> c (m a) -> m (<a href="Test-Hspec-Core-Spec.html#t:Tree">Tree</a> c a) <a href="#v:sequence" class="selflink">#</a></p></div></div></td></tr></table></div></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a id="t:Item" class="def">Item</a> a <a href="src/Test-Hspec-Core-Tree.html#Item" class="link">Source</a> <a href="#t:Item" class="selflink">#</a></p><div class="doc"><p><code>Item</code> is used to represent spec items internally. A spec item consists of:</p><ul><li>a textual description of a desired behavior</li><li>an example for that behavior</li><li>additional meta information</li></ul><p>Everything that is an instance of the <code><a href="Test-Hspec-Core-Spec.html#t:Example">Example</a></code> type class can be used as an
example, including QuickCheck properties, Hspec expectations and HUnit
assertions.</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a id="v:Item" class="def">Item</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div class="subs fields"><p class="caption">Fields</p><ul><li><dfn class="src"><a id="v:itemRequirement" class="def">itemRequirement</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-String.html#t:String">String</a></dfn><div class="doc"><p>Textual description of behavior</p></div></li><li><dfn class="src"><a id="v:itemLocation" class="def">itemLocation</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Test-Hspec-Core-Spec.html#t:Location">Location</a></dfn><div class="doc"><p>Source location of the spec item</p></div></li><li><dfn class="src"><a id="v:itemIsParallelizable" class="def">itemIsParallelizable</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Bool.html#t:Bool">Bool</a></dfn><div class="doc"><p>A flag that indicates whether it is safe to evaluate this spec item in
parallel with other spec items</p></div></li><li><dfn class="src"><a id="v:itemExample" class="def">itemExample</a> :: <a href="Test-Hspec-Core-Spec.html#t:Params">Params</a> -> (<a href="Test-Hspec-Core-Spec.html#t:ActionWith">ActionWith</a> a -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/System-IO.html#t:IO">IO</a> ()) -> <a href="Test-Hspec-Core-Spec.html#t:ProgressCallback">ProgressCallback</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/System-IO.html#t:IO">IO</a> <a href="Test-Hspec-Core-Spec.html#t:Result">Result</a></dfn><div class="doc"><p>Example for behavior</p></div></li></ul></div></td></tr></table></div></div><div class="top"><p class="src"><a id="v:specGroup" class="def">specGroup</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-String.html#t:String">String</a> -> [<a href="Test-Hspec-Core-Spec.html#t:SpecTree">SpecTree</a> a] -> <a href="Test-Hspec-Core-Spec.html#t:SpecTree">SpecTree</a> a <a href="src/Test-Hspec-Core-Tree.html#specGroup" class="link">Source</a> <a href="#v:specGroup" class="selflink">#</a></p><div class="doc"><p>The <code>specGroup</code> function combines a list of specs into a larger spec.</p></div></div><div class="top"><p class="src"><a id="v:specItem" class="def">specItem</a> :: (?loc :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/GHC-Stack.html#t:CallStack">CallStack</a>, <a href="Test-Hspec-Core-Spec.html#t:Example">Example</a> a) => <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-String.html#t:String">String</a> -> a -> <a href="Test-Hspec-Core-Spec.html#t:SpecTree">SpecTree</a> (<a href="Test-Hspec-Core-Spec.html#t:Arg">Arg</a> a) <a href="src/Test-Hspec-Core-Tree.html#specItem" class="link">Source</a> <a href="#v:specItem" class="selflink">#</a></p><div class="doc"><p>The <code>specItem</code> function creates a spec item.</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.17.2</p></div></body></html>
|