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
  - Test_outcome
ppx_expect.common
- Expect_test_common
  - Expectation
    
    Body
    
    Raw
  - File
    
    Digest
    
    Location
    
    Name
  - Std
ppx_expect.config
- Expect_test_config
  - IO
ppx_expect.config_types
- Expect_test_config_types
  - S
    
    IO
  - Upon_unreleasable_issue
ppx_expect.evaluator
- Ppx_expect_evaluator
ppx_expect.make_corrected_file
- Make_corrected_file
ppx_expect.matcher
- Expect_test_matcher
  - Choose_tag
  - Cst
    
    Line
  - Fmt
  - 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

val f : 
  ?use_dot_patdiff:Base.bool ->
  ?corrected_path:Base.string ->
  ?use_color:Base.bool ->
  ?diff_command:Base.string ->
  ?diff_path_prefix:Base.string ->
  next_contents:Base.string ->
  path:Base.string ->
  Base.unit ->
  Base.unit Base.Or_error.t

f ~next_contents ~path () compares the contents of path against next_contents. If the contents are unchanged, f returns Ok (). If they are changed, it writes next_contents to corrected_path, emits a build error, and returns Error _. The caller should exit nonzero (possibly by raising the returned error) to indicate to the build that an error occurred. If it doesn't, the build system may not recognize that a corrected file has been generated and needs to be moved out of a sandbox.

The optional arguments support "expert" use cases. Most clients do not need them.