package speed

You can search for identifiers within the package.

in-package search v0.2.0

package speed

speed
- Library speed
  - Speed
    
    Domain
    
    Assertions
    
    Runner
    
    Metadata
    
    Dsl
    
    List
    
    Effect
    
    Domain
    
    ROOT_SUITE
    
    Make
    
    Sync
    
    LwtEffectDsl
    
    MakeTypes
    
    Simple
  - Speed_assertions
    
    AssertionResult
  - Speed_domain
    
    Metadata
    
    TestInput
    
    DOMAIN
    
    TEST_RESULT
    
    Make
    
    MakeFunctions
    
    SyncTestResult
    
    LwtTestResult
    
    MakeComplex
    
    Dom
    
    Sync
    
    Dom
    
    LwtDomain
    
    Dom
    
    Dom
  - Speed_dsl_effect
    
    Domain
    
    ROOT_SUITE
    
    Make
    
    MakeTypes
    
    Sync
    
    MakeTypes
    
    LwtEffectDsl
    
    MakeTypes
    
    MakeTypes
  - Speed_dsl_effect_simple
    
    Domain
    
    ROOT_SUITE
    
    Make
    
    Sync
    
    LwtEffectDsl
  - Speed_dsl_list
    
    Domain
    
    Make
    
    Sync
    
    LwtDsl
  - Speed_metadata
    
    List
  - Speed_runner
    
    Domain
    
    Dsl
    
    Assertions
    
    ExampleRunner
    
    EXAMPLE_RUNNER
    
    SyncRunner
    
    LwtRunner
    
    Reporter
    
    Make
    
    SyncRunner
    
    LwtRunner
- Library speed_ppx_fun
  - Speed_ppx_fun
    
    Ppx_fun
- Library speed_ppx_matcher
  - Speed_ppx_matcher
    
    Ppx_matcher
- Library speed_ppx_metadata
  - Speed_ppx_metadata
    
    Ppx_metadata
- Sources
  - speed
    
    Speed.ml
    
    Speed_assertions.ml
    
    Speed_domain.ml
    
    Speed_dsl_effect.ml
    
    Speed_dsl_effect_simple.ml
    
    Speed_dsl_list.ml
    
    Speed_metadata.ml
    
    Speed_runner.ml
  - speed_ppx_fun
    
    ppx_fun.ml
    
    speed_ppx_fun.ml
  - speed_ppx_matcher
    
    ppx_matcher.ml
    
    speed_ppx_matcher.ml
  - speed_ppx_metadata
    
    ppx_metadata.ml
    
    speed_ppx_metadata.ml

Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module `Speed_runner`Source

Sourcemodule Domain = Speed_domain

Sourcemodule Dsl = Speed_dsl_list

Sourcemodule Assertions = Speed_assertions

Sourcetype metadata = Speed_metadata.t

Sourcetype suite_result = {

success : bool;
print_break : bool;
no_of_failing_examples : int;
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

Source

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

Sourcemodule SyncRunner : sig ... end

Sourcemodule LwtRunner : sig ... end

include module type of struct include SyncRunner end

Source

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

| Root : (unit Domain.test_input -> 'a0) -> (unit, 'a0) setup_stack
| 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

Source

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

Source

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

Source

val 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

Source

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

Source

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

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

Source

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

Source

val 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

Source

val run_suites : 
  fmt:Format.formatter ->
  unit Domain.Sync.t ->
  unit Domain.LwtDomain.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.

package speed

Module Speed_runnerSource

Module `Speed_runner`Source