package apero-core

  1. Overview
  2. Docs
include module type of Lwt
type +'a t
type -'a u
val wait : unit -> 'a t * 'a u
val wakeup_later : 'a u -> 'a -> unit
val wakeup_later_exn : 'a u -> exn -> unit
val return : 'a -> 'a t
val fail : exn -> 'a t
val bind : 'a t -> ('a -> 'b t) -> 'b t
val catch : (unit -> 'a t) -> (exn -> 'a t) -> 'a t
val finalize : (unit -> 'a t) -> (unit -> unit t) -> 'a t
val try_bind : (unit -> 'a t) -> ('a -> 'b t) -> (exn -> 'b t) -> 'b t
val async : (unit -> unit t) -> unit
val async_exception_hook : (exn -> unit) Stdlib.ref
val both : 'a t -> 'b t -> ('a * 'b) t
val join : unit t list -> unit t
val all : 'a t list -> 'a list t
val pick : 'a t list -> 'a t
val choose : 'a t list -> 'a t
val npick : 'a t list -> 'a list t
val nchoose : 'a t list -> 'a list t
val nchoose_split : 'a t list -> ('a list * 'a t list) t
exception Canceled
val task : unit -> 'a t * 'a u
val cancel : 'a t -> unit
val on_cancel : 'a t -> (unit -> unit) -> unit
val protected : 'a t -> 'a t
val no_cancel : 'a t -> 'a t
val map : ('a -> 'b) -> 'a t -> 'b t
val on_success : 'a t -> ('a -> unit) -> unit
val on_failure : 'a t -> (exn -> unit) -> unit
val on_termination : 'a t -> (unit -> unit) -> unit
val on_any : 'a t -> ('a -> unit) -> (exn -> unit) -> unit
module Infix : sig ... end
val return_unit : unit t
val return_none : 'a option t
val return_nil : 'a list t
val return_true : bool t
val return_false : bool t
type !'a result = ('a, exn) Result.result
val wakeup_later_result : 'a u -> 'a result -> unit
type !'a state =
  1. | Return of 'a
  2. | Fail of exn
  3. | Sleep
val state : 'a t -> 'a state
type 'a key
val new_key : unit -> 'a key
val get : 'a key -> 'a option
val with_value : 'a key -> 'a option -> (unit -> 'b) -> 'b
val wakeup : 'a u -> 'a -> unit
val wakeup_exn : 'a u -> exn -> unit
val wakeup_result : 'a u -> 'a result -> unit
val make_value : 'a -> 'a result
  • deprecated Use Result.Ok, which is the same as Ok since OCaml 4.03.
val make_error : exn -> 'a result
  • deprecated Use Result.Error, which is the same as Error since OCaml 4.03.
val waiter_of_wakener : 'a u -> 'a t
  • deprecated This function should be avoided, because it makes subtyping of resolvers unsound. See https://github.com/ocsigen/lwt/issues/458
val add_task_r : 'a u Lwt_sequence.t -> 'a t
  • deprecated Deprecated because Lwt_sequence is an implementation detail of Lwt. See https://github.com/ocsigen/lwt/issues/361
val add_task_l : 'a u Lwt_sequence.t -> 'a t
  • deprecated Deprecated because Lwt_sequence is an implementation detail of Lwt. See https://github.com/ocsigen/lwt/issues/361
val pause : unit -> unit t
val wakeup_paused : unit -> unit
val paused_count : unit -> int
val register_pause_notifier : (int -> unit) -> unit
val wrap : (unit -> 'a) -> 'a t
val wrap1 : ('a -> 'b) -> 'a -> 'b t
val wrap2 : ('a -> 'b -> 'c) -> 'a -> 'b -> 'c t
val wrap3 : ('a -> 'b -> 'c -> 'd) -> 'a -> 'b -> 'c -> 'd t
val wrap4 : ('a -> 'b -> 'c -> 'd -> 'e) -> 'a -> 'b -> 'c -> 'd -> 'e t
val wrap5 : ('a -> 'b -> 'c -> 'd -> 'e -> 'f) -> 'a -> 'b -> 'c -> 'd -> 'e -> 'f t
val wrap6 : ('a -> 'b -> 'c -> 'd -> 'e -> 'f -> 'g) -> 'a -> 'b -> 'c -> 'd -> 'e -> 'f -> 'g t
val wrap7 : ('a -> 'b -> 'c -> 'd -> 'e -> 'f -> 'g -> 'h) -> 'a -> 'b -> 'c -> 'd -> 'e -> 'f -> 'g -> 'h t
val return_some : 'a -> 'a option t
val return_ok : 'a -> ('a, 'b) Result.result t
val return_error : 'e -> ('a, 'e) Result.result t
val fail_with : string -> 'a t
val fail_invalid_arg : string -> 'a t
val (>>=) : 'a t -> ('a -> 'b t) -> 'b t
val (>|=) : 'a t -> ('a -> 'b) -> 'b t
val (<?>) : 'a t -> 'a t -> 'a t
val (<&>) : unit t -> unit t -> unit t
val (=<<) : ('a -> 'b t) -> 'a t -> 'b t
val (=|<) : ('a -> 'b) -> 'a t -> 'b t
val is_sleeping : 'a t -> bool
val ignore_result : 'a t -> unit
val poll : 'a t -> 'a option
val apply : ('a -> 'b t) -> 'a -> 'b t
val backtrace_bind : (exn -> exn) -> 'a t -> ('a -> 'b t) -> 'b t
val backtrace_catch : (exn -> exn) -> (unit -> 'a t) -> (exn -> 'a t) -> 'a t
val backtrace_finalize : (exn -> exn) -> (unit -> 'a t) -> (unit -> unit t) -> 'a t
val backtrace_try_bind : (exn -> exn) -> (unit -> 'a t) -> ('a -> 'b t) -> (exn -> 'b t) -> 'b t
val abandon_wakeups : unit -> unit
val debug_state_is : 'a state -> 'a t -> bool t
val fold_m : ('a -> 'b -> 'a Lwt.t) -> 'a -> 'b list -> 'a Lwt.t
val lift : ('a -> 'b) -> 'a Lwt.t -> 'b Lwt.t
val flatten : 'a Lwt.t list -> 'a list Lwt.t
val of_result : ('e -> exn) -> ('a, 'e) Result.t -> 'a Lwt.t
val sequence : 'a Lwt.t -> 'b Lwt.t Stdlib.Lazy.t -> 'b Lwt.t
val read_mvar : 'a Lwt_mvar.t -> 'a Lwt.t
module InfixM : sig ... end
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct