Idris2Doc : Hedgehog.Internal.Report

Hedgehog.Internal.Report

(source)
Definitions
record FailedAnnotation : Type
  Totality: total
  Visibility: public export
  Constructor: 
MkFailedAnnotation : String -> FailedAnnotation

  Projection: 
.failedValue : FailedAnnotation -> String

  Hints:
  
Eq FailedAnnotation
  
Show FailedAnnotation
.failedValue : FailedAnnotation -> String
  Totality: total
  Visibility: public export
failedValue : FailedAnnotation -> String
  Totality: total
  Visibility: public export
record FailureReport : Type
  Totality: total
  Visibility: public export
  Constructor: 
MkFailureReport : Size -> StdGen -> ShrinkCount -> Maybe (Coverage CoverCount) -> List (Lazy FailedAnnotation) -> String -> Maybe Diff -> List (Lazy String) -> FailureReport

  Projections:
  
.annotations : FailureReport -> List (Lazy FailedAnnotation)
  
.coverage : FailureReport -> Maybe (Coverage CoverCount)
  
.diff : FailureReport -> Maybe Diff
  
.footnotes : FailureReport -> List (Lazy String)
  
.message : FailureReport -> String
  
.seed : FailureReport -> StdGen
  
.shrinks : FailureReport -> ShrinkCount
  
.size : FailureReport -> Size

  Hints:
  
Eq FailureReport
  
Show FailureReport
.size : FailureReport -> Size
  Totality: total
  Visibility: public export
size : FailureReport -> Size
  Totality: total
  Visibility: public export
.seed : FailureReport -> StdGen
  Totality: total
  Visibility: public export
seed : FailureReport -> StdGen
  Totality: total
  Visibility: public export
.shrinks : FailureReport -> ShrinkCount
  Totality: total
  Visibility: public export
shrinks : FailureReport -> ShrinkCount
  Totality: total
  Visibility: public export
.coverage : FailureReport -> Maybe (Coverage CoverCount)
  Totality: total
  Visibility: public export
coverage : FailureReport -> Maybe (Coverage CoverCount)
  Totality: total
  Visibility: public export
.annotations : FailureReport -> List (Lazy FailedAnnotation)
  Totality: total
  Visibility: public export
annotations : FailureReport -> List (Lazy FailedAnnotation)
  Totality: total
  Visibility: public export
.message : FailureReport -> String
  Totality: total
  Visibility: public export
message : FailureReport -> String
  Totality: total
  Visibility: public export
.diff : FailureReport -> Maybe Diff
  Totality: total
  Visibility: public export
diff : FailureReport -> Maybe Diff
  Totality: total
  Visibility: public export
.footnotes : FailureReport -> List (Lazy String)
  Totality: total
  Visibility: public export
footnotes : FailureReport -> List (Lazy String)
  Totality: total
  Visibility: public export
data Progress : Type
  The status of a running property test.

  Totality: total
  Visibility: public export
  Constructors:
  
Running : Progress
  
Shrinking : FailureReport -> Progress

  Hints:
  
Eq Progress
  
Show Progress
data Result : Type
  The status of a completed property test.
  
  In the case of a failure it provides the seed used for the test, the
  number of shrinks, and the execution log.

  Totality: total
  Visibility: public export
  Constructors:
  
Failed : FailureReport -> Result
  
OK : Result

  Hints:
  
Eq Result
  
Show Result
isFailure : Result -> Bool
  Totality: total
  Visibility: public export
isSuccess : Result -> Bool
  Totality: total
  Visibility: public export
record Report : Type -> Type
  A report on a running or completed property test.

  Totality: total
  Visibility: public export
  Constructor: 
MkReport : TestCount -> Coverage CoverCount -> a -> Report a

  Projections:
  
.coverage : Report a -> Coverage CoverCount
  
.status : Report a -> a
  
.tests : Report a -> TestCount

  Hints:
  
Eq a => Eq (Report a)
  
Foldable Report
  
Functor Report
  
Show a => Show (Report a)
  
Traversable Report
.tests : Report a -> TestCount
  Totality: total
  Visibility: public export
tests : Report a -> TestCount
  Totality: total
  Visibility: public export
.coverage : Report a -> Coverage CoverCount
  Totality: total
  Visibility: public export
coverage : Report a -> Coverage CoverCount
  Totality: total
  Visibility: public export
.status : Report a -> a
  Totality: total
  Visibility: public export
status : Report a -> a
  Totality: total
  Visibility: public export
record Summary : Type
  A summary of all the properties executed.

  Totality: total
  Visibility: public export
  Constructor: 
MkSummary : PropertyCount -> PropertyCount -> PropertyCount -> PropertyCount -> Summary

  Projections:
  
.failed : Summary -> PropertyCount
  
.ok : Summary -> PropertyCount
  
.running : Summary -> PropertyCount
  
.waiting : Summary -> PropertyCount

  Hints:
  
Eq Summary
  
Monoid Summary
  
Semigroup Summary
  
Show Summary
.waiting : Summary -> PropertyCount
  Totality: total
  Visibility: public export
waiting : Summary -> PropertyCount
  Totality: total
  Visibility: public export
.running : Summary -> PropertyCount
  Totality: total
  Visibility: public export
running : Summary -> PropertyCount
  Totality: total
  Visibility: public export
.failed : Summary -> PropertyCount
  Totality: total
  Visibility: public export
failed : Summary -> PropertyCount
  Totality: total
  Visibility: public export
.ok : Summary -> PropertyCount
  Totality: total
  Visibility: public export
ok : Summary -> PropertyCount
  Totality: total
  Visibility: public export
fromResult : Result -> Summary
  Construct a summary from a single result.

  Totality: total
  Visibility: export
summaryCompleted : Summary -> PropertyCount
  Totality: total
  Visibility: export
summaryTotal : Summary -> PropertyCount
  Totality: total
  Visibility: export
takeAnnotation : Lazy Log -> Maybe (Lazy FailedAnnotation)
  Totality: total
  Visibility: export
takeFootnote : Lazy Log -> Maybe (Lazy String)
  Totality: total
  Visibility: export
mkFailure : Size -> StdGen -> ShrinkCount -> Maybe (Coverage CoverCount) -> String -> Maybe Diff -> List (Lazy Log) -> FailureReport
  Totality: total
  Visibility: export
data MarkupStyle : Type
  Totality: total
  Visibility: public export
  Constructors:
  
StyleDefault : MarkupStyle
  
StyleAnnotation : MarkupStyle
  
StyleFailure : MarkupStyle

  Hints:
  
Eq MarkupStyle
  
Ord MarkupStyle
  
Semigroup MarkupStyle
  
Show MarkupStyle
data Markup : Type
  Totality: total
  Visibility: public export
  Constructors:
  
WaitingIcon : Markup
  
WaitingHeader : Markup
  
RunningIcon : Markup
  
RunningHeader : Markup
  
ShrinkingIcon : Markup
  
ShrinkingHeader : Markup
  
FailedIcon : Markup
  
FailedText : Markup
  
SuccessIcon : Markup
  
SuccessText : Markup
  
CoverageIcon : Markup
  
CoverageText : Markup
  
CoverageFill : Markup
  
StyledBorder : MarkupStyle -> Markup
  
AnnotationValue : Markup
  
DiffPrefix : Markup
  
DiffInfix : Markup
  
DiffSuffix : Markup
  
DiffSame : Markup
  
DiffRemoved : Markup
  
DiffAdded : Markup
  
ReproduceHeader : Markup
  
ReproduceGutter : Markup
  
ReproduceSource : Markup

  Hints:
  
Eq Markup
  
Ord Markup
  
Show Markup
ppProgress : UseColor -> Maybe PropertyName -> Report Progress -> Doc opts
  Totality: total
  Visibility: export
ppSummary : UseColor -> Summary -> Doc opts
  Totality: total
  Visibility: export
LL80 : LayoutOpts
  Totality: total
  Visibility: public export
renderDoc : Doc LL80 -> String
  Totality: total
  Visibility: export
renderProgress : UseColor -> Maybe PropertyName -> Report Progress -> String
  Totality: total
  Visibility: export
renderResult : UseColor -> Maybe PropertyName -> Report Result -> String
  Totality: total
  Visibility: export
renderSummary : UseColor -> Summary -> String
  Totality: total
  Visibility: export
report : Bool -> TestCount -> Size -> StdGen -> Coverage CoverCount -> Maybe Confidence -> Report Result
  Totality: total
  Visibility: export