package ppx_expect

You can search for identifiers within the package.

in-package search v0.2.0

ppx_expect.collector
- Expect_test_collector
  - Current_file
  - Make
    
    Config
    
    IO_flush
    
    IO_run
  - Test_outcome
ppx_expect.common
- Expect_test_common
  - Expectation
    
    Body
    
    Raw
  - File
    
    Digest
    
    Location
    
    Name
  - Std
ppx_expect.config
- Expect_test_config
  - IO_flush
  - IO_run
  - S
    
    IO_flush
    
    IO_run
  - Upon_unreleasable_issue
ppx_expect.evaluator
- Ppx_expect_evaluator
ppx_expect.matcher
- Expect_test_matcher
  - Choose_tag
  - Cst
    
    Line
  - Fmt
  - Import
  - Lexer
  - Matcher
    
    Saved_output
    
    Test_correction
    
    Node_correction
    
    Uncaught_exn
    
    Test_outcome
  - Reconcile
    
    Result
  - Std
ppx_expect.payload
- Ppx_expect_payload

Legend:
Library
Module
Module type
Parameter
Class
Class type

Configuration for running expect tests

To configure expect_test, add the following at the top of your .ml file, or in some import.ml:

module Expect_test_config = struct
  include Expect_test_config
  let pre_redirect_hook () = ...
end

Note that since all expect test are also inline tests, the inline test configuration also applies to all expect test.

module Upon_unreleasable_issue : sig ... end

module type S = sig ... end

include S with type 'a IO_flush.t = 'a with type 'a IO_run.t = 'a

module IO_run : sig ... end

module IO_flush : sig ... end

val flush : unit -> unit IO_flush.t

Flush whatever need to be to get pending output out on file descriptor 0.

val run : (unit -> unit IO_run.t) -> unit

Run an IO operation until completion

val flushed : unit -> bool

Synchronous check that there is no pending output on file description 0. With async, there is no guarantee that on the rhs of a IO.bind (flush ()) ... the output is completely flushed, that's why we need this.

val upon_unreleasable_issue : Upon_unreleasable_issue.t

upon_unreleasable_issue specifies how to deal with output that should not be released even if it is accepted (e.g. backtraces). The default is `CR.