package async

You can search for identifiers within the package.

in-package search v0.2.0

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

Unpack_sequence uses an Unpack_buffer.t to unpack a sequence of packed values coming from a string Pipe.Reader.t or a Reader.t. It can produce a pipe of upacked values or iterate a user-supplied function over the unpacked values.

module Unpack_iter_result : sig ... end

module Unpack_result : sig ... end

module Unpack_from : sig ... end

Unpack_from specifies the source of the sequence of bytes to unpack from.

val unpack_into_pipe : 
  from:Unpack_from.t ->
  using:'a Unpack_buffer.t ->
  'a Async.Pipe.Reader.t * 'a Unpack_result.t Async.Deferred.t

unpack_into_pipe ~from:input ~using:unpack_buffer returns (output, result), and uses unpack_buffer to unpack values from input until input is closed. It puts the unpacked values into output, which is closed once unpacking finishes, be it normally or due to an error. result indicates why unpacking finished.

To unpack from a bin_reader, use:

unpack_into_pipe ~from ~using:(Unpack_buffer.create_bin_prot bin_reader)

Using ~from:(Reader reader) is more efficient than ~from:(Pipe (Reader.pipe reader)) because it blits bytes directly from the reader buffer to the unpack buffer, without any intervening allocation.

val unpack_iter : 
  from:Unpack_from.t ->
  using:'a Unpack_buffer.t ->
  f:('a -> unit) ->
  'a Unpack_iter_result.t Async.Deferred.t

unpack_iter is a more efficient version of unpack_into_pipe that calls f on each value as it is unpacked, rather than putting the value into a pipe. If f raises, then the result will be Unpack_error.