package async

You can search for identifiers within the package.

in-package search v0.2.0

package async

async
- Async
  - Async_kernel_require_explicit_time_source
    
    Clock_ns
    
    Event
    
    Status
    
    Scheduler
    
    Deferred
    
    Choice
    
    Handler
    
    Infix
    
    Let_syntax
    
    Let_syntax
    
    Open_on_rhs
    
    M
    
    Let_syntax
    
    Let_syntax
    
    Open_on_rhs
    
    Monad_infix
    
    Monad_infix
    
    Monad_sequence
    
    Scheduler
    
    Bvar
    
    Event
    
    Abort_result
    
    Fields
    
    Direct
    
    Status
    
    Fields
    
    Direct
    
    Ivar
    
    Job_or_event
    
    Match
    
    Synchronous_time_source
    
    Alarm
    
    Event
    
    Abort_result
    
    Fields
    
    Direct
    
    Status
    
    Read_write
    
    T1
    
    Event
    
    Fields
    
    Direct
    
    Status
    
    Fields
    
    Direct
    
    Job_or_event
    
    Match
    
    Time_ns
    
    Very_low_priority_worker
    
    Exec_result
    
    Fields
    
    Direct
    
    Unregister
    
    Very_low_priority_work
    
    Worker_result
    
    Time_ns
  - Async_kernel_scheduler
    
    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
    
    Read_write
    
    T1
    
    Event
    
    Fields
    
    Direct
    
    Status
    
    Fields
    
    Direct
    
    Job_or_event
    
    Match
    
    Time_ns
    
    Very_low_priority_worker
    
    Exec_result
    
    Fields
    
    Direct
    
    Unregister
    
    Very_low_priority_work
    
    Worker_result
  - Condition
  - Deferred
    
    Or_error
    
    Expect_test_config
    
    IO
  - Expect_test_config
    
    IO
  - Gc
    
    Alarm
  - Invariant
    
    Async
    
    S
    
    S1
    
    S2
    
    S3
  - Quickcheck
    
    Configure
    
    Config
  - 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
    
    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.lock_file_async
- Lock_file_async
  - Flock
  - Nfs
async.log_extended
- Log_extended
  - 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

type nonrec 'a t = 'a -> unit Async_kernel.Deferred.t

module type S = sig ... end

module type S1 = sig ... end

module type S2 = sig ... end

module type S3 = sig ... end

val invariant : 
  Core_kernel.Source_code_position.t ->
  'a ->
  ('a -> Core_kernel.Sexp.t) ->
  (unit -> unit Async_kernel.Deferred.t) ->
  unit Async_kernel.Deferred.t

val check_field : 
  'a ->
  'b t ->
  unit Async_kernel.Deferred.t ->
  ('a, 'b) Core_kernel.Field.t ->
  unit Async_kernel.Deferred.t

check_field can be used to check record fields when using [@@deriving fields]. Idiomatic usage looks like:

type t = { foo : Foo.t ; bar : Bar.t }
[@@deriving fields]

let invariant t =
  Invariant.Async.invariant [%here] t [%sexp_of: t] (fun () ->
    let check inv = Invariant.Async.check_field t inv in
    Fields.fold ~init:(return ())
      ~foo: (check Foo.invariant)
      ~bar: (check Bar.invariant)

When some fields have synchronous invariants, or do not need to be checked, it may be useful to define a second wrapper around check_field:

type t = { foo : Foo.t ; bar : Bar.t ; quux : Quux.t }
[@@deriving fields]

let invariant t =
  Invariant.Async.invariant [%here] t [%sexp_of: t] (fun () ->
    let check' inv = Invariant.Async.check_field t inv in
    let check inv = check' (fun x -> inv x; return ()) in
    Fields.fold ~init:(return ())
      ~foo:  (check' Foo.invariant)
      ~bar:  (check  Bar.invariant)
      ~quux: (check  ignore)