package async

You can search for identifiers within the package.

in-package search v0.2.0

async
- Async
  - Command
  - Deferred
    
    Or_error
    
    Expect_test_config
    
    IO_flush
    
    IO_run
  - Expect_test_config
    
    IO_flush
    
    IO_run
  - Expect_test_config_or_error
    
    IO_flush
    
    IO_run
  - Ppx_log_syntax
    
    Global
    
    No_global
    
    Ppx_log_syntax
    
    Global
  - Quickcheck
async.async_command
- Async_command
  - Staged
async.async_quickcheck
- Async_quickcheck
  - Configure
    
    Config
async.async_rpc
- Async_rpc
  - Rpc
    
    Connection
    
    Low_latency_transport
    
    Config
    
    Reader
    
    With_internal_reader
    
    With_internal_reader
    
    Writer
    
    Transport
    
    Reader
    
    Tcp
    
    Writer
async.lock_file_async
- Lock_file_async
  - Flock
  - Nfs
  - Symlink
async.log_extended
- Log_extended
  - Command
  - Console
    
    Blocking
  - Syslog
    
    Blocking
async.persistent_connection
- Persistent_connection
  - Make
    
    Conn
    
    Event
  - Rpc
    
    Event
  - S
    
    Event
  - S_rpc
    
    Event
  - Versioned_rpc
    
    Event
async.unpack_sequence
- Unpack_sequence

Legend:
Library
Module
Module type
Parameter
Class
Class type

The default expect test config in code which has open Async.

%expect has type unit rather than unit Deferred.t. This lets one write:

[%expect {| |};

rather than:

let%bind () = [%expect {| |}] in

It also means that let%expect cannot terminate with %expect, and must instead terminate with return ().

include Expect_test_config_types.S
  with type 'a IO_flush.t = 'a
  with type 'a IO_run.t = 'a Async_kernel.Deferred.t

module IO_run : sig ... end

module IO_flush : sig ... end

A now-legacy monad. This signature used to declare a flush function. [%expect.output] still returns this type. No meaningful monadic work is done.

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 sanitize : string -> string

sanitize can be used to map all output strings, e.g. for cleansing.

val upon_unreleasable_issue : [ `CR | `Warning_for_collector_testing ]

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.