package speed

  1. Overview
  2. Docs
package speed
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Speed_runnerSource

Sourcemodule Domain = Speed_domain
Sourcemodule Assertions = Speed_assertions
Sourcetype metadata = Speed_metadata.t
Sourcetype suite_result = {
  1. success : bool;
  2. print_break : bool;
  3. no_of_failing_examples : int;
  4. no_of_passing_examples : int;
}
Sourceval (>>) : ('a -> 'b) -> ('b -> 'c) -> 'a -> 'c
Sourcetype 'a continuation = (suite_result -> 'a) -> 'a
Sourcemodule ExampleRunner : sig ... end
Sourcemodule Reporter : sig ... end
Sourcemodule SyncRunner : sig ... end
Sourcemodule LwtRunner : sig ... end
include module type of struct include SyncRunner end
Sourcetype (!'a, !'b) setup_stack = ('a, 'b) Make(Domain.Sync)(ExampleRunner.SyncRunner).setup_stack =
  1. | Root : (unit Domain.test_input -> 'a0) -> (unit, 'a0) setup_stack
  2. | Stack : ('a1, 'b0) setup_stack * ('b0 Domain.test_input -> 'c) -> ('a1, 'c) setup_stack
Sourceval filter_suite : 'a Domain.Sync.t -> 'a Domain.Sync.t
Sourceval filter_suite_mixed : 'a Domain.Sync.child_suite -> 'a Domain.Sync.child_suite
Sourceval start_group : string option -> Format.formatter -> suite_result -> (suite_result -> ('a -> 'b) -> 'c) -> ('a -> 'b) -> 'c
Sourceval start_example : string -> Format.formatter -> suite_result -> (suite_result -> (suite_result -> ExampleRunner.test_outcome -> 'a) -> 'b) -> (suite_result -> 'a) -> 'b
Sourceval run_setup : metadata list -> (unit, 'b) setup_stack -> 'b
Sourceval run_suite_wait : ?fmt:Format.formatter -> unit Domain.Sync.t -> suite_result
Sourceval is_success : suite_result -> bool
Sourceval get_no_of_failing_examples : suite_result -> int
Sourceval get_no_of_passing_examples : suite_result -> int
Sourceval consume_test_result : Format.formatter -> suite_result -> 'a
Sourceval has_focused : 'a Domain.Sync.t -> bool
Sourceval run_suite : ?fmt:Format.formatter -> unit Domain.Sync.t -> suite_result
Sourceval 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.