package speed

You can search for identifiers within the package.

in-package search v0.2.0

package speed

speed
- Speed
  - Dsl
    
    Effect
- Speed_assertions
  - AssertionResult
- Speed_domain
  - DOMAIN
  - LwtDomain
    
    Dom
  - LwtTestResult
  - Make
    
    R
  - MakeComplex
    
    Dom
    
    T
  - MakeFunctions
    
    D
  - Sync
    
    Dom
  - SyncTestResult
  - TEST_RESULT
  - TestInput
- Speed_dsl_effect
  - LwtEffectDsl
    
    MakeTypes
    
    C
  - Make
    
    D
    
    MakeTypes
    
    C
    
    RootSuite
  - ROOT_SUITE
  - Sync
    
    MakeTypes
    
    C
- Speed_dsl_effect_simple
  - LwtEffectDsl
  - Make
    
    D
    
    RootSuite
  - ROOT_SUITE
  - Sync
- Speed_dsl_list
  - LwtDsl
  - Make
    
    T
  - Sync
- Speed_metadata
  - List
- Speed_runner
  - ExampleRunner
    
    EXAMPLE_RUNNER
    
    LwtRunner
    
    SyncRunner
  - LwtRunner
  - Make
    
    D
    
    Runner
  - Reporter
  - SyncRunner

Legend:
Library
Module
Module type
Parameter
Class
Class type

module Domain = Speed_domain

module Dsl = Speed_dsl_list

module Assertions = Speed_assertions

type metadata = Speed_metadata.t

type suite_result = {

success : bool;
print_break : bool;
no_of_failing_examples : int;
no_of_passing_examples : int;

}

val (>>) : ('a -> 'b) -> ('c -> 'd) -> 'e -> 'f

type 'a continuation = (suite_result -> 'a) -> 'a

module ExampleRunner : sig ... end

module Reporter : sig ... end

module Make
  (D : Domain.DOMAIN)
  (Runner : 
    ExampleRunner.EXAMPLE_RUNNER with type test_function = unit D.test_function) : 
  sig ... end

module SyncRunner : sig ... end

module LwtRunner : sig ... end

include module type of struct include SyncRunner end

type (!'a, !'b) setup_stack =
  ('a, 'b) Make(Domain.Sync)(ExampleRunner.SyncRunner).setup_stack =

| Root : (unit Domain.test_input -> 'a0) -> (unit, 'a1) setup_stack
| Stack : ('a2, 'b0) setup_stack * ('b1 Domain.test_input -> 'c) -> ('a3, 'c0) setup_stack

val filter_suite : 'a Domain.Sync.t -> 'a Domain.Sync.t

val filter_suite_mixed : 
  'a Domain.Sync.child_suite ->
  'a Domain.Sync.child_suite

val start_group : 
  string option ->
  Format.formatter ->
  suite_result ->
  (suite_result -> ('a -> 'b) -> 'c) ->
  ('d -> 'e) ->
  'f

val start_example : 
  string ->
  Format.formatter ->
  suite_result ->
  (suite_result -> (suite_result -> ExampleRunner.test_outcome -> 'a) -> 'b) ->
  (suite_result -> 'c) ->
  'd

val run_setup : metadata list -> (unit, 'b) setup_stack -> 'b

val run_ex : 
  Format.formatter ->
  suite_result ->
  'a Domain.Sync.example ->
  Speed_domain.Metadata.t list ->
  (unit, 'a0) setup_stack ->
  (suite_result -> 'b ExampleRunner.SyncRunner.cont_result) ->
  'c ExampleRunner.SyncRunner.cont_result

val run_child_suite : 
  Format.formatter ->
  suite_result ->
  'a Domain.Sync.t ->
  metadata list ->
  (unit, 'a) setup_stack ->
  'b ExampleRunner.SyncRunner.cont_result continuation

val wait : 'a ExampleRunner.SyncRunner.cont_result -> 'a

val run_suite_return : 
  ?fmt:Format.formatter ->
  unit Domain.Sync.t ->
  suite_result ExampleRunner.SyncRunner.cont_result

val run_suite_wait : 
  ?fmt:Format.formatter ->
  unit Domain.Sync.t ->
  suite_result

val is_success : suite_result -> bool

val get_no_of_failing_examples : suite_result -> int

val get_no_of_passing_examples : suite_result -> int

val consume_test_result : Format.formatter -> suite_result -> 'a

val has_focused : 'a Domain.Sync.t -> bool

val run_suite : ?fmt:Format.formatter -> unit Domain.Sync.t -> suite_result

val run_suites : 
  fmt:Format.formatter ->
  unit Domain.Sync.t ->
  unit Domain.LwtDomain.t ->
  suite_result

val run_root_suites : unit -> 'a

This runs the test suite and exits the program. If the test suite is successful, it will exit with exit code zero, otherwise it will exit with exit code 1.