Async (u.6acb507e01f3b07b20e7fb057a1830da.async.v0.17.0.doc.async.Async)

Async_kernel

include module type of struct include Async_kernel end

module Async_kernel_config = Async_kernel.Async_kernel_config

module Async_kernel_require_explicit_time_source =
  Async_kernel.Async_kernel_require_explicit_time_source

Sourcemodule Async_kernel_scheduler = Async_kernel.Async_kernel_scheduler

Sourcemodule Bvar = Async_kernel.Bvar

Sourcemodule Clock_ns = Async_kernel.Clock_ns

Sourcemodule Condition = Async_kernel.Condition

Sourcemodule Execution_context = Async_kernel.Execution_context

Sourcemodule Gc = Async_kernel.Gc

Sourcemodule Invariant = Async_kernel.Invariant

Sourcemodule Ivar = Async_kernel.Ivar

Sourcemodule Lazy_deferred = Async_kernel.Lazy_deferred

Sourcemodule Monad_sequence = Async_kernel.Monad_sequence

Sourcemodule Monitor = Async_kernel.Monitor

Sourcemodule Mvar = Async_kernel.Mvar

Sourcemodule Pipe = Async_kernel.Pipe

Sourcemodule Priority = Async_kernel.Priority

Sourcemodule Sequencer = Async_kernel.Sequencer

Sourcemodule Stream = Async_kernel.Stream

Sourcemodule Synchronous_time_source = Async_kernel.Synchronous_time_source

Sourcemodule Tail = Async_kernel.Tail

Sourcemodule Throttle = Async_kernel.Throttle

Sourcemodule Throttled = Async_kernel.Throttled

Sourcemodule Time_source = Async_kernel.Time_source

Toplevel functions

The functions below are broadly useful when writing Async programs, and so are made available at the toplevel.

Source

val catch : 
  ?here:Core.Source_code_position.t ->
  ?info:Core.Info.t ->
  ?name:string ->
  (unit -> unit) ->
  exn Async_kernel.Deferred.t

Source

val choice : 
  'a Async_kernel.Deferred.t ->
  ('a -> 'b) ->
  'b Async_kernel.Deferred.Choice.t

Source

val choose : 
  'a Async_kernel.Deferred.Choice.t list ->
  'a Async_kernel.Deferred.t

Sourceval don't_wait_for : unit Async_kernel.Deferred.t -> unit

Sourceval never : unit -> 'a Async_kernel.Deferred.t

Source

val try_with : 
  ?here:Core.Source_code_position.t ->
  ?info:Core.Info.t ->
  ?name:string ->
  ?extract_exn:bool ->
  ?run:[ `Now | `Schedule ] ->
  ?rest:[ `Call of exn -> unit | `Log | `Raise ] ->
  (unit -> 'a Async_kernel.Deferred.t) ->
  ('a, exn) Core.Result.t Async_kernel.Deferred.t

Sourceval upon : 'a Async_kernel.Deferred.t -> ('a -> unit) -> unit

Source

val with_timeout_exn : 
  Core.Core_private.Time_ns_alternate_sexp.Span.t ->
  'a Async_kernel.Deferred.t ->
  error:Core.Error.t ->
  'a Async_kernel.Deferred.t

Infix operators and `Let_syntax` support

include Core.Monad.Infix with type 'a t := 'a Async_kernel.Deferred.t

Sourceval (>>>) : 'a Async_kernel.Deferred.t -> ('a -> unit) -> unit

equivalent to Deferred.upon.

Source

val (>>=?) : 
  ('a, 'b) Async_kernel.Deferred.Result.t ->
  ('a -> ('c, 'b) Async_kernel.Deferred.Result.t) ->
  ('c, 'b) Async_kernel.Deferred.Result.t

equivalent to Deferred.Result.bind.

Source

val (>>|?) : 
  ('a, 'b) Async_kernel.Deferred.Result.t ->
  ('a -> 'c) ->
  ('c, 'b) Async_kernel.Deferred.Result.t

equivalent to Deferred.Result.map.

include module type of struct include Async_kernel.Deferred.Let_syntax end

Sourceval return : 'a -> 'a Async_kernel.Deferred.t

Source

val (>>=) : 
  'a Async_kernel.Deferred.t ->
  ('a -> 'b Async_kernel.Deferred.t) ->
  'b Async_kernel.Deferred.t

t >>= f returns a computation that sequences the computations represented by two monad elements. The resulting computation first does t to yield a value v, and then runs the computation returned by f v.

Source

val (>>|) : 
  'a Async_kernel.Deferred.t ->
  ('a -> 'b) ->
  'b Async_kernel.Deferred.t

t >>| f is t >>= (fun a -> return (f a)).

Sourcemodule Let_syntax = Async_kernel.Let_syntax

Sourcemodule Deferred : sig ... end

Async_unix

include module type of struct include Async_unix end

Sourcemodule Async_config = Async_unix.Async_config

Sourcemodule Busy_poller = Async_unix.Busy_poller

Sourcemodule Clock = Async_unix.Clock

Sourcemodule Dump_core_on_job_delay = Async_unix.Dump_core_on_job_delay

Sourcemodule Fd = Async_unix.Fd

Sourcemodule In_thread = Async_unix.In_thread

Sourcemodule Io_stats = Async_unix.Io_stats

Sourcemodule Io_uring_raw = Async_unix.Io_uring_raw

Sourcemodule Io_uring_raw_singleton = Async_unix.Io_uring_raw_singleton

Sourcemodule Io_uring = Async_unix.Io_uring

Sourcemodule Print = Async_unix.Print

Sourcemodule Process = Async_unix.Process

Sourcemodule Reader = Async_unix.Reader

Sourcemodule Require_explicit_time_source = Async_unix.Require_explicit_time_source

Sourcemodule Scheduler = Async_unix.Scheduler

Sourcemodule Shutdown = Async_unix.Shutdown

Sourcemodule Signal = Async_unix.Signal

Sourcemodule Socket = Async_unix.Socket

Sourcemodule Sys = Async_unix.Sys

Sourcemodule Tcp = Async_unix.Tcp

Sourcemodule Thread_safe = Async_unix.Thread_safe

Sourcemodule Writer = Async_unix.Writer

Sourcemodule Unix = Async_unix.Unix

Sourceval after : Async_unix__.Import.Time.Span.t -> unit Async_kernel.Deferred.t

Sourceval at : Async_unix__.Import.Time.t -> unit Async_kernel.Deferred.t

Source

val every : 
  ?start:unit Async_kernel.Deferred.t ->
  ?stop:unit Async_kernel.Deferred.t ->
  ?continue_on_error:bool ->
  Async_unix__.Import.Time.Span.t ->
  (unit -> unit) ->
  unit

Source

val with_timeout : 
  Async_unix__.Import.Time.Span.t ->
  'a Async_kernel.Deferred.t ->
  'a Clock.Or_timeout.t Async_kernel.Deferred.t

Source

val schedule : 
  ?monitor:Async_kernel.Monitor.t ->
  ?priority:Async_kernel.Priority.t ->
  (unit -> unit) ->
  unit

Source

val schedule' : 
  ?monitor:Async_kernel.Monitor.t ->
  ?priority:Async_kernel.Priority.t ->
  (unit -> 'a Async_kernel.Deferred.t) ->
  'a Async_kernel.Deferred.t

Sourceval shutdown : ?force:unit Async_kernel.Deferred.t -> int -> unit

Source

val within : 
  ?monitor:Async_kernel.Monitor.t ->
  ?priority:Async_kernel.Priority.t ->
  (unit -> unit) ->
  unit

Source

val within' : 
  ?monitor:Async_kernel.Monitor.t ->
  ?priority:Async_kernel.Priority.t ->
  (unit -> 'a Async_kernel.Deferred.t) ->
  'a Async_kernel.Deferred.t

Sourcemodule Printf = Async_unix.Printf

Shadow blocking functions in Core.Printf to prevent their unintentional use.

include sig ... end

Sourcemodule Overwrite_ = Async_unix.Overwrite_

Source

val close_in_noerr : 
  [< `This_is_async__Think_about_blocking ] ->
  [> `This_is_async__Think_about_blocking ]

Source

val close_in : 
  [< `This_is_async__Think_about_blocking ] ->
  [> `This_is_async__Think_about_blocking ]

Source

val close_out_noerr : 
  [< `This_is_async__Think_about_blocking ] ->
  [> `This_is_async__Think_about_blocking ]

Source

val close_out : 
  [< `This_is_async__Think_about_blocking ] ->
  [> `This_is_async__Think_about_blocking ]

Sourceval eprintf : ('a, unit, string, unit) format4 -> 'a

Source

val flush_all : 
  [< `This_is_async__Think_about_blocking ] ->
  [> `This_is_async__Think_about_blocking ]

Source

val flush : 
  [< `This_is_async__Think_about_blocking ] ->
  [> `This_is_async__Think_about_blocking ]

Sourceval fprintf : Async_unix.Writer.t -> ('a, unit, string, unit) format4 -> 'a

Sourceval ifprintf : 'a -> ('b, 'a, 'c, unit) format4 -> 'b

Source

val in_channel_length : 
  [< `This_is_async__Think_about_blocking ] ->
  [> `This_is_async__Think_about_blocking ]

Source

val input_binary_int : 
  [< `This_is_async__Think_about_blocking ] ->
  [> `This_is_async__Think_about_blocking ]

Source

val input_byte : 
  [< `This_is_async__Think_about_blocking ] ->
  [> `This_is_async__Think_about_blocking ]

Source

val input_char : 
  [< `This_is_async__Think_about_blocking ] ->
  [> `This_is_async__Think_about_blocking ]

Source

val input_line : 
  [< `This_is_async__Think_about_blocking ] ->
  [> `This_is_async__Think_about_blocking ]

Source

val input_lines : 
  ?fix_win_eol:'a ->
  [< `This_is_async__Think_about_blocking ] ->
  [> `This_is_async__Think_about_blocking ]

Source

val input : 
  [< `This_is_async__Think_about_blocking ] ->
  [< `This_is_async__Think_about_blocking ] ->
  [< `This_is_async__Think_about_blocking ] ->
  [< `This_is_async__Think_about_blocking ] ->
  [> `This_is_async__Think_about_blocking ]

Source

val input_value : 
  [< `This_is_async__Think_about_blocking ] ->
  [> `This_is_async__Think_about_blocking ]

Source

val open_in_bin : 
  [< `This_is_async__Think_about_blocking ] ->
  [> `This_is_async__Think_about_blocking ]

Source

val open_in_gen : 
  [< `This_is_async__Think_about_blocking ] ->
  [< `This_is_async__Think_about_blocking ] ->
  [< `This_is_async__Think_about_blocking ] ->
  [> `This_is_async__Think_about_blocking ]

Source

val open_in : 
  [< `This_is_async__Think_about_blocking ] ->
  [> `This_is_async__Think_about_blocking ]

Source

val open_out_bin : 
  [< `This_is_async__Think_about_blocking ] ->
  [> `This_is_async__Think_about_blocking ]

Source

val open_out_gen : 
  [< `This_is_async__Think_about_blocking ] ->
  [< `This_is_async__Think_about_blocking ] ->
  [< `This_is_async__Think_about_blocking ] ->
  [> `This_is_async__Think_about_blocking ]

Source

val open_out : 
  [< `This_is_async__Think_about_blocking ] ->
  [> `This_is_async__Think_about_blocking ]

Source

val out_channel_length : 
  [< `This_is_async__Think_about_blocking ] ->
  [> `This_is_async__Think_about_blocking ]

Source

val output_binary_int : 
  [< `This_is_async__Think_about_blocking ] ->
  [< `This_is_async__Think_about_blocking ] ->
  [> `This_is_async__Think_about_blocking ]

Source

val output_byte : 
  [< `This_is_async__Think_about_blocking ] ->
  [< `This_is_async__Think_about_blocking ] ->
  [> `This_is_async__Think_about_blocking ]

Source

val output_char : 
  [< `This_is_async__Think_about_blocking ] ->
  [< `This_is_async__Think_about_blocking ] ->
  [> `This_is_async__Think_about_blocking ]

Source

val output : 
  [< `This_is_async__Think_about_blocking ] ->
  [< `This_is_async__Think_about_blocking ] ->
  [< `This_is_async__Think_about_blocking ] ->
  [< `This_is_async__Think_about_blocking ] ->
  [> `This_is_async__Think_about_blocking ]

Source

val output_string : 
  [< `This_is_async__Think_about_blocking ] ->
  [< `This_is_async__Think_about_blocking ] ->
  [> `This_is_async__Think_about_blocking ]

Source

val output_value : 
  [< `This_is_async__Think_about_blocking ] ->
  [< `This_is_async__Think_about_blocking ] ->
  [> `This_is_async__Think_about_blocking ]

Source

val pos_in : 
  [< `This_is_async__Think_about_blocking ] ->
  [> `This_is_async__Think_about_blocking ]

Source

val pos_out : 
  [< `This_is_async__Think_about_blocking ] ->
  [> `This_is_async__Think_about_blocking ]

Sourceval prerr_char : char -> unit

Sourceval prerr_endline : string -> unit

Sourceval prerr_float : float -> unit

Sourceval prerr_int : int -> unit

Sourceval prerr_newline : unit -> unit

Sourceval prerr_string : string -> unit

Sourceval print_char : char -> unit

Sourceval print_endline : string -> unit

Sourceval print_float : float -> unit

Sourceval printf : ('a, unit, string, unit) format4 -> 'a

Sourceval print_int : int -> unit

Sourceval print_newline : unit -> unit

Sourceval print_s : ?mach:unit -> Sexplib.Sexp.t -> unit

Sourceval print_string : string -> unit

Source

val read_float : 
  [< `This_is_async__Think_about_blocking ] ->
  [> `This_is_async__Think_about_blocking ]

Source

val read_int : 
  [< `This_is_async__Think_about_blocking ] ->
  [> `This_is_async__Think_about_blocking ]

Source

val read_line : 
  [< `This_is_async__Think_about_blocking ] ->
  [> `This_is_async__Think_about_blocking ]

Source

val read_lines : 
  [< `This_is_async__Think_about_blocking ] ->
  [> `This_is_async__Think_about_blocking ]

Source

val read_wrap : 
  ?binary:'a ->
  f:'b ->
  [< `This_is_async__Think_about_blocking ] ->
  [> `This_is_async__Think_about_blocking ]

Source

val really_input : 
  [< `This_is_async__Think_about_blocking ] ->
  [< `This_is_async__Think_about_blocking ] ->
  [< `This_is_async__Think_about_blocking ] ->
  [< `This_is_async__Think_about_blocking ] ->
  [> `This_is_async__Think_about_blocking ]

Source

val seek_in : 
  [< `This_is_async__Think_about_blocking ] ->
  [< `This_is_async__Think_about_blocking ] ->
  [> `This_is_async__Think_about_blocking ]

Source

val seek_out : 
  [< `This_is_async__Think_about_blocking ] ->
  [> `This_is_async__Think_about_blocking ]

Source

val set_binary_mode_in : 
  [< `This_is_async__Think_about_blocking ] ->
  [< `This_is_async__Think_about_blocking ] ->
  [> `This_is_async__Think_about_blocking ]

Source

val set_binary_mode_out : 
  [< `This_is_async__Think_about_blocking ] ->
  [< `This_is_async__Think_about_blocking ] ->
  [> `This_is_async__Think_about_blocking ]

Source

val write_lines : 
  [< `This_is_async__Think_about_blocking ] ->
  [< `This_is_async__Think_about_blocking ] ->
  [> `This_is_async__Think_about_blocking ]

Source

val write_wrap : 
  ?binary:'a ->
  f:'b ->
  [< `This_is_async__Think_about_blocking ] ->
  [> `This_is_async__Think_about_blocking ]

Source

val eprint_s : 
  [< `This_is_async__Think_about_blocking ] ->
  [> `This_is_async__Think_about_blocking ]

Sourceval eprint_s_nonblocking : ?mach:unit -> Sexplib.Sexp.t -> unit

Sourcemodule LargeFile = Async_unix.LargeFile

Sourcemodule Sexp = Async_unix.Sexp

Source

val exit : 
  ?force:unit Async_kernel.Deferred.t ->
  int ->
  'a Async_kernel.Deferred.t

Async_log

Sourcemodule Log : sig ... end

include module type of struct include Async_log.Ppx_log_syntax end

module Ppx_log_syntax = Async_log.Ppx_log_syntax.Ppx_log_syntax

Async_log.Ppx_log_syntax.Ppx_log_syntax exists so that people can open Async_log.Ppx_log_syntax to use ppx log, instead of doing a module alias. This is consistent with Monad.Syntax.Let_syntax.

Async_command

Sourcemodule Command : sig ... end

Async_rpc

include module type of struct include Async_rpc end

Sourcemodule Rpc = Async_rpc.Rpc

module Versioned_rpc = Async_rpc.Versioned_rpc

Sourcemodule Quickcheck : sig ... end

Sourcemodule Expect_test_config : sig ... end

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

Sourcemodule Expect_test_config_or_error : sig ... end

An alternative to Async.Deferred_or_error_expect_test_config in which %expect has type unit rather than unit Deferred.Or_error.t. This lets one write:

Async_kernel

Toplevel functions

Infix operators and Let_syntax support

Async_unix

Async_log

Async_command

Async_rpc

Infix operators and `Let_syntax` support