Idris2Doc : Evince.Core

Evince.Core

(source)

Reexports

import public Decidable.Equality
import public Evince.SrcLoc
import public Control.Monad.Trans
import public Control.Monad.Identity

Definitions

data FailureInfo : Type
Totality: total
Visibility: public export
Constructors:
ExpectedButGot : String -> String -> String -> FailureInfo
PredicateFailed : String -> String -> FailureInfo
Reason : String -> FailureInfo

Hints:
DecEq FailureInfo
Show FailureInfo
data TestResult : Type -> Type
Totality: total
Visibility: public export
Constructors:
Pass : a -> TestResult a
Fail : FailureInfo -> TestResult a
Skip : Maybe String -> TestResult a

Hints:
Applicative TestResult
DecEq a => DecEq (TestResult a)
Functor TestResult
Monad TestResult
Show a => Show (TestResult a)
data TestResultT : (Type -> Type) -> Type -> Type
  A chain of expectations in an inner monad `m`: `>>=` stops at the first
`Fail` or `Skip`, so a test body of several expectations reports its
first failure. Plain `m` actions enter via `lift`/`liftIO`, a plain
`TestResult` via `liftResult`; `runTestResultT` runs the chain.

Totality: total
Visibility: public export
Constructor: 
MkTestResultT : m (TestResult a) -> TestResultT m a

Hints:
Monad m => Applicative (TestResultT m)
Functor m => Functor (TestResultT m)
HasIO m => HasIO (TestResultT m)
Monad m => Monad (TestResultT m)
MonadTrans TestResultT
runTestResultT : TestResultT m a -> m (TestResult a)
  Run a chain in its inner monad, producing its final result.

Totality: total
Visibility: export
runPure : TestResultT Identity a -> TestResult a
  Run a chain that performs no effects, e.g. to compare a custom
expectation's result against `Pass`, `Fail` or `Skip`.

Totality: total
Visibility: export
liftResult : Applicative m => TestResult a -> TestResultT m a
  Lift a plain result into a chain, e.g. a custom expectation built from
`Pass` and `Fail`.

Totality: total
Visibility: export
hoistIO : HasIO m => TestResultT IO a -> TestResultT m a
  Lift an `IO` chain into a chain over any monad that can run IO.

Totality: total
Visibility: export
interface Hoist : (Type -> Type) -> (Type -> Type) -> Type
  Lifts a body written in monad `n` into a spec over monad `m`. A chain in
the spec's own monad runs as it is, an `IO` chain through `liftIO`, and a
body whose monad nothing else fixes runs in the spec's monad.

Parameters: n, m
Methods:
hoistChain : TestResultT n a -> TestResultT m a

Implementation: 
HasIO m => Hoist IO m
hoistChain : Hoist n m => TestResultT n a -> TestResultT m a
Totality: total
Visibility: public export
SameMonad : Hoist m m
  The fallback that runs a body in the spec's own monad.

Totality: total
Visibility: public export
data SpecTree : (Type -> Type) -> Type -> Type
Totality: total
Visibility: public export
Constructors:
Describe : String -> List (SpecTree m a) -> SpecTree m a
It : String -> Maybe SrcLoc -> (a -> m (TestResult ())) -> SpecTree m a
Pending : String -> Maybe String -> SpecTree m a
Focused : SpecTree m a -> SpecTree m a
WithCleanup : m () -> List (SpecTree m a) -> SpecTree m a
data Spec : (Type -> Type) -> Type -> Type -> Type
Totality: total
Visibility: public export
Constructor: 
MkSpec : SnocList (SpecTree m a) -> b -> Spec m a b

Hints:
Applicative (Spec m a)
Functor (Spec m a)
Monad (Spec m a)
getSpecTrees : Spec m a () -> List (SpecTree m a)
  Extract the tree list from a completed spec.

Totality: total
Visibility: export
record Summary : Type
Totality: total
Visibility: public export
Constructor: 
MkSummary : Nat -> Nat -> Nat -> Integer -> Summary

Projections:
.duration : Summary -> Integer
.failed : Summary -> Nat
.passed : Summary -> Nat
.pending : Summary -> Nat

Hints:
Monoid Summary
Semigroup Summary
Show Summary
.passed : Summary -> Nat
Totality: total
Visibility: public export
passed : Summary -> Nat
Totality: total
Visibility: public export
.failed : Summary -> Nat
Totality: total
Visibility: public export
failed : Summary -> Nat
Totality: total
Visibility: public export
.pending : Summary -> Nat
Totality: total
Visibility: public export
pending : Summary -> Nat
Totality: total
Visibility: public export
.duration : Summary -> Integer
Totality: total
Visibility: public export
duration : Summary -> Integer
Totality: total
Visibility: public export
totalCount : Summary -> Nat
Totality: total
Visibility: export
record RunConfig : Type
Totality: total
Visibility: public export
Constructor: 
MkRunConfig : Bool -> Bool -> Maybe String -> Maybe String -> Bool -> Maybe Nat -> Maybe String -> Bool -> Nat -> Bool -> RunConfig

Projections:
.color : RunConfig -> Bool
.failFast : RunConfig -> Bool
.jobs : RunConfig -> Nat
.junitOutput : RunConfig -> Maybe String
.match : RunConfig -> Maybe String
.randomize : RunConfig -> Bool
.rerun : RunConfig -> Bool
.seed : RunConfig -> Maybe Nat
.showTiming : RunConfig -> Bool
.skip : RunConfig -> Maybe String
.failFast : RunConfig -> Bool
Totality: total
Visibility: public export
failFast : RunConfig -> Bool
Totality: total
Visibility: public export
.showTiming : RunConfig -> Bool
Totality: total
Visibility: public export
showTiming : RunConfig -> Bool
Totality: total
Visibility: public export
.match : RunConfig -> Maybe String
Totality: total
Visibility: public export
match : RunConfig -> Maybe String
Totality: total
Visibility: public export
.skip : RunConfig -> Maybe String
Totality: total
Visibility: public export
skip : RunConfig -> Maybe String
Totality: total
Visibility: public export
.randomize : RunConfig -> Bool
Totality: total
Visibility: public export
randomize : RunConfig -> Bool
Totality: total
Visibility: public export
.seed : RunConfig -> Maybe Nat
Totality: total
Visibility: public export
seed : RunConfig -> Maybe Nat
Totality: total
Visibility: public export
.junitOutput : RunConfig -> Maybe String
Totality: total
Visibility: public export
junitOutput : RunConfig -> Maybe String
Totality: total
Visibility: public export
.rerun : RunConfig -> Bool
Totality: total
Visibility: public export
rerun : RunConfig -> Bool
Totality: total
Visibility: public export
.jobs : RunConfig -> Nat
Totality: total
Visibility: public export
jobs : RunConfig -> Nat
Totality: total
Visibility: public export
.color : RunConfig -> Bool
Totality: total
Visibility: public export
color : RunConfig -> Bool
Totality: total
Visibility: public export
defaultConfig : RunConfig
  Default configuration: no fail-fast, no timing, no filters, colored output.

Totality: total
Visibility: export