Module Use.Deferred

type nonrec 'a t = 'a Async_kernel.Deferred.t
val sexp_of_t : ('a -> Sexplib0.Sexp.t) -> 'a t -> Sexplib0.Sexp.t
include Async_kernel.Invariant.S1 with type 'a t := 'a t
val invariant : ('a -> unit) -> 'a t -> unit
include Core.Monad with type 'a t := 'a t
val return : 'a 'i 'p 'q. 'a -> 'a t

Convert a value to a t.

val map : 'a 'b 'i 'j 'p 'q. 'a t -> f:('a -> 'b) -> 'b t

Transforms the contents of a t.

val bind : 'a 'b 'i 'j 'k 'p 'q. 'a t -> f:('a -> 'b t) -> 'b t

Sequences computations. bind t ~f computes f v for value(s) v in t. Well-behaved monads satisfy these "laws" (where ( >>= ) is the infix bind operator):

  • map t ~f is equivalent to bind t ~f:(fun x -> return (f x))
  • return x >>= f is equivalent to f x
  • t >>= return is equivalent to t
  • (t >>= f) >>= g is equivalent to t >>= fun x -> f x >>= g
val join : 'a 'i 'j 'k 'p 'q. 'a t t -> 'a t

Combines nested t into just one layer. Equivalent to bind t ~f:Fn.id.

val ignore_m : 'a 'i 'j 'p 'q. 'a t -> unit t

Ignores contained values of t. Equivalent to map t ~f:ignore.

val all : 'a 'i 'p 'q. 'a t list -> 'a list t

Combines a list of t.

val all_unit : 'i 'p 'q. unit t list -> unit t

Combines a list of t whose contents are unimportant.

val (>>=) : 'a 'b 'i 'j 'k 'p 'q. 'a t -> ('a -> 'b t) -> 'b t

Infix bind.

val (>>|) : 'a 'b 'i 'j 'p 'q. 'a t -> ('a -> 'b) -> 'b t

Infix map.

module Monad_infix : sig ... end
module Let_syntax : sig ... end
module Infix : sig ... end
val any : 'a t list -> 'a t
val any_unit : unit t list -> unit t
val both : 'a t -> 'b t -> ('a * 'b) t
val create : ('a Async_kernel.Ivar.t -> unit) -> 'a t
val don't_wait_for : unit t -> unit
val is_determined : 'a t -> bool
val never : unit -> _ t
val ok : 'a t -> ('a, _) Core.Result.t t
val peek : 'a t -> 'a option
val unit : unit t
val upon : 'a t -> ('a -> unit) -> unit
val value_exn : 'a t -> 'a
val repeat_until_finished : 'state -> ('state -> [ `Repeat of 'state | `Finished of 'result ] t) -> 'result t
module Array : Async_kernel.Monad_sequence.S with type 'a monad := 'a t with type 'a t := 'a array
module Iarray : Async_kernel.Monad_sequence.S with type 'a monad := 'a t with type 'a t := 'a iarray
module List : sig ... end
module Queue : Async_kernel.Monad_sequence.S with type 'a monad := 'a t with type 'a t := 'a Core.Queue.t

Similar to {Deferred.Queue} but eager when passing ~how:`Sequential. The functions in Queue raise if the queue is mutated during execution.

module Or_error : sig ... end
module Memo : Async_kernel.Deferred.Memo.S with type 'a deferred := 'a t
module Result : sig ... end