package async

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Parameters
Signature

package async

async
- Async
  - Async_kernel_require_explicit_time_source
    
    Async_kernel_scheduler
    
    Clock_ns
    
    Event
    
    Status
    
    Date
    
    Time
    
    Time_ns
  - Command
  - Condition
  - Deferred
    
    Or_error
    
    Expect_test_config
    
    IO_flush
    
    IO_run
  - Expect_test_config
    
    IO_flush
    
    IO_run
  - Expect_test_config_with_unit_expect
    
    IO_flush
    
    IO_run
  - Gc
    
    Alarm
  - Invariant
    
    Async
    
    S
    
    S1
    
    S2
    
    S3
  - Quickcheck
  - Stream
    
    Deferred
    
    Choice
    
    Handler
    
    Infix
    
    Let_syntax
    
    Let_syntax
    
    M
    
    Let_syntax
    
    Let_syntax
    
    Open_on_rhs
    
    Monad_infix
    
    Monad_sequence
    
    Scheduler
    
    Bvar
    
    Fields
    
    Direct
    
    Ivar
    
    Synchronous_time_source
    
    Alarm
    
    Event
    
    Abort_result
    
    Reschedule_result
    
    Id
    
    Hash_queue
    
    Hash_set
    
    Provide_bin_io
    
    X
    
    Provide_of_sexp
    
    X
    
    Map
    
    Key
    
    Provide_bin_io
    
    Key
    
    Provide_hash
    
    Key
    
    Provide_of_sexp
    
    Key
    
    Tree
    
    Provide_of_sexp
    
    K
    
    Replace_polymorphic_compare
    
    Set
    
    Elt
    
    Named
    
    Provide_bin_io
    
    Elt
    
    Provide_hash
    
    Elt
    
    Provide_of_sexp
    
    Elt
    
    Tree
    
    Named
    
    Provide_of_sexp
    
    Elt
    
    Table
    
    Provide_bin_io
    
    Key
    
    Provide_of_sexp
    
    Key
    
    Read_write
    
    T1
    
    Event
    
    Fields
    
    Direct
    
    Status
    
    Fields
    
    Direct
    
    Job_or_event
    
    Match
    
    Time_ns
    
    Very_low_priority_worker
    
    Exec_result
    
    Fields
    
    Direct
    
    Unregister
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
    
    Writer
    
    Transport
    
    Reader
    
    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
    
    Address
    
    Event
  - Rpc
    
    Event
  - S
    
    Event
  - Versioned_rpc
    
    Event
async.unpack_sequence
- Unpack_sequence

Legend:
Library
Module
Module type
Parameter
Class
Class type

Parameters

module Config : Core_kernel.Quickcheck.Quickcheck_config

Signature

include Core_kernel.Quickcheck.Quickcheck_configured

include Core_kernel.Quickcheck_intf.Quickcheck_config

val default_seed : Core_kernel.Quickcheck_intf.seed

default_seed is used initialize the pseudo-random generator that chooses random values from generators, in each test that is not provided its own seed.

val default_sizes : Base.Int.t Core_kernel.Sequence.t

default_sizes determines the default sequence of sizes used in generating values.

val default_trial_count : Base.Int.t

default_trial_count determines the number of trials per test, except in tests that explicitly override it.

val default_can_generate_trial_count : Base.Int.t

default_can_generate_trial_count determines the number of trials used in attempts to generate satisfying values, except in tests that explicitly override it.

val default_shrink_attempts : Core_kernel.Quickcheck_intf.shrink_attempts

default_shrink_attempts determines the number of attempts at shrinking when running test or iter with ~shrinker and without ~shrink_attempts

val random_value : 
  ?seed:Core_kernel.Quickcheck_intf.seed ->
  ?size:Base.Int.t ->
  'a Base_quickcheck.Generator.t ->
  'a

random_value gen produces a single value chosen from gen using seed.

val iter : 
  ?seed:Core_kernel.Quickcheck_intf.seed ->
  ?sizes:Base.Int.t Core_kernel.Sequence.t ->
  ?trials:Base.Int.t ->
  'a Base_quickcheck.Generator.t ->
  f:('a -> Base.Unit.t) ->
  Base.Unit.t

iter gen ~f runs f on up to trials different values generated by gen. It stops successfully after trials successful trials or if gen runs out of values. It raises an exception if f raises an exception.

val test : 
  ?seed:Core_kernel.Quickcheck_intf.seed ->
  ?sizes:Base.Int.t Core_kernel.Sequence.t ->
  ?trials:Base.Int.t ->
  ?shrinker:'a Base_quickcheck.Shrinker.t ->
  ?shrink_attempts:Core_kernel.Quickcheck_intf.shrink_attempts ->
  ?sexp_of:('a -> Base.Sexp.t) ->
  ?examples:'a Base.List.t ->
  'a Base_quickcheck.Generator.t ->
  f:('a -> Base.Unit.t) ->
  Base.Unit.t

test gen ~f is like iter, with optional concrete examples that are tested before values from gen, and additional information provided on failure. If f raises an exception and sexp_of is provided, the exception is re-raised with a description of the random input that triggered the failure. If f raises an exception and shrinker is provided, it will be used to attempt to shrink the value that caused the exception with re-raising behaving the same as for unshrunk inputs.

val test_or_error : 
  ?seed:Core_kernel.Quickcheck_intf.seed ->
  ?sizes:Base.Int.t Core_kernel.Sequence.t ->
  ?trials:Base.Int.t ->
  ?shrinker:'a Base_quickcheck.Shrinker.t ->
  ?shrink_attempts:Core_kernel.Quickcheck_intf.shrink_attempts ->
  ?sexp_of:('a -> Base.Sexp.t) ->
  ?examples:'a Base.List.t ->
  'a Base_quickcheck.Generator.t ->
  f:('a -> Base.Unit.t Core_kernel.Or_error.t) ->
  Base.Unit.t Core_kernel.Or_error.t

test_or_error is like test, except failure is determined using Or_error.t. Any exceptions raised by f are also treated as failures.

val test_can_generate : 
  ?seed:Core_kernel.Quickcheck_intf.seed ->
  ?sizes:Base.Int.t Core_kernel.Sequence.t ->
  ?trials:Base.Int.t ->
  ?sexp_of:('a -> Base.Sexp.t) ->
  'a Base_quickcheck.Generator.t ->
  f:('a -> Base.Bool.t) ->
  Base.Unit.t

test_can_generate gen ~f is useful for testing gen values, to make sure they can generate useful examples. It tests gen by generating up to trials values and passing them to f. Once a value satisfies f, the iteration stops. If no values satisfy f, test_can_generate raises an exception. If sexp_of is provided, the exception includes all of the generated values.

val test_distinct_values : 
  ?seed:Core_kernel.Quickcheck_intf.seed ->
  ?sizes:Base.Int.t Core_kernel.Sequence.t ->
  ?sexp_of:('a -> Base.Sexp.t) ->
  'a Base_quickcheck.Generator.t ->
  trials:Base.Int.t ->
  distinct_values:Base.Int.t ->
  compare:('a -> 'a -> Base.Int.t) ->
  Base.Unit.t

test_distinct_values gen is useful for testing gen values, to make sure they create sufficient distinct values. It tests gen by generating up to trials values and making sure at least distinct_values of the resulting values are unique with respect to compare. If too few distinct values are generated, test_distinct_values raises an exception. If sexp_of is provided, the exception includes the values generated.

val random_sequence : 
  ?seed:Core_kernel.Quickcheck_intf.seed ->
  ?sizes:Base.Int.t Core_kernel.Sequence.t ->
  'a Base_quickcheck.Generator.t ->
  'a Core_kernel.Sequence.t

random_sequence ~seed gen produces a sequence of values chosen from gen.

val async_test : 
  ?seed:Core_kernel.Quickcheck.seed ->
  ?trials:int ->
  ?sexp_of:('a -> Core_kernel.Sexp.t) ->
  'a Core_kernel.Quickcheck.Generator.t ->
  f:('a -> unit Async_kernel.Deferred.t) ->
  unit Async_kernel.Deferred.t

Like test, but for asynchronous tests.