package async_kernel

You can search for identifiers within the package.

in-package search v0.2.0

Monadic concurrency library

Install

Dune Dependency

github.com Readme Changelog MIT License Edit opam file Versions (6)

Authors

J

Jane Street Group, LLC

Maintainers

J

Jane Street developers

Sources

v0.17.0.tar.gz

sha256=01ced973dbc70535f692f38bed524ae82dba17e26e58791b2fbf0d647b160d2e

doc/async_kernel.eager_deferred/Eager_deferred/Use/Deferred/index.html

Module `Use.Deferred`Source

Sourcetype nonrec 'a t = 'a Async_kernel.Deferred.t

Sourceval sexp_of_t : ('a -> Sexplib0.Sexp.t) -> 'a t -> Sexplib0.Sexp.t

include Async_kernel.Invariant.S1 with type 'a t := 'a t

Sourceval invariant : ('a -> unit) -> 'a t -> unit

include Core.Monad with type 'a t := 'a t

Sourceval (>>=) : 'a t -> ('a -> 'b t) -> 'b 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.

Sourceval (>>|) : 'a t -> ('a -> 'b) -> 'b t

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

Sourcemodule Monad_infix : sig ... end

Sourceval bind : 'a t -> f:('a -> 'b t) -> 'b t

bind t ~f = t >>= f

Sourceval return : 'a -> 'a t

return v returns the (trivial) computation that returns v.

Sourceval map : 'a t -> f:('a -> 'b) -> 'b t

map t ~f is t >>| f.

Sourceval join : 'a t t -> 'a t

join t is t >>= (fun t' -> t').

Sourceval ignore_m : 'a t -> unit t

ignore_m t is map t ~f:(fun _ -> ()). ignore_m used to be called ignore, but we decided that was a bad name, because it shadowed the widely used Stdlib.ignore. Some monads still do let ignore = ignore_m for historical reasons.

Sourceval all : 'a t list -> 'a list t

Sourceval all_unit : unit t list -> unit t

Like all, but ensures that every monadic value in the list produces a unit value, all of which are discarded rather than being collected into a list.

Sourcemodule Let_syntax : sig ... end

These are convenient to have in scope when programming with a monad:

Sourcemodule Infix : sig ... end

Sourceval any : 'a t list -> 'a t

Sourceval any_unit : unit t list -> unit t

Sourceval both : 'a t -> 'b t -> ('a * 'b) t

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

Sourceval don't_wait_for : unit t -> unit

Sourceval is_determined : 'a t -> bool

Sourceval never : unit -> _ t

Sourceval ok : 'a t -> ('a, _) Core.Result.t t

Sourceval peek : 'a t -> 'a option

Sourceval unit : unit t

Sourceval upon : 'a t -> ('a -> unit) -> unit

Sourceval value_exn : 'a t -> 'a

Source

val repeat_until_finished : 
  'state ->
  ('state -> [ `Repeat of 'state | `Finished of 'result ] t) ->
  'result t

Source

module List : 
  Async_kernel.Monad_sequence.S
    with type 'a monad := 'a t
    with type 'a t := 'a list

Source

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.

Sourcemodule Or_error : sig ... end

Sourcemodule Memo : Async_kernel.Deferred.Memo.S with type 'a deferred := 'a t

Sourcemodule Result : sig ... end

package async_kernel

Install

Dune Dependency

Authors

Maintainers

Sources

doc/async_kernel.eager_deferred/Eager_deferred/Use/Deferred/index.html

Module Use.DeferredSource

Module `Use.Deferred`Source