package lwt

You can search for identifiers within the package.

in-package search v0.2.0

lwt
- Lwt
  - Infix
    
    Let_syntax
    
    Open_on_rhs
- Lwt_condition
- Lwt_list
- Lwt_mutex
- Lwt_mvar
- Lwt_pool
- Lwt_pqueue
  - Make
    
    Ord
  - OrderedType
  - S
- Lwt_result
  - Infix
- Lwt_sequence
- Lwt_stream
  - bounded_push
- Lwt_switch
lwt.unix
- Lwt_bytes
- Lwt_config
- Lwt_engine
  - Ev_backend
  - Versioned
    
    libev_1
    
    libev_2
  - abstract
  - libev
  - poll_based
  - select
  - select_based
  - t
- Lwt_fmt
- Lwt_gc
- Lwt_io
  - BE
  - LE
  - NumberIO
  - Versioned
- Lwt_main
- Lwt_preemptive
- Lwt_process
- Lwt_sys
- Lwt_throttle
  - Make
    
    H
  - S
- Lwt_timeout
- Lwt_unix
- Lwt_unix_jobs
  - Job
  - Make
    
    Job

Legend:
Library
Module
Module type
Parameter
Class
Class type

This module provides several infix operators for making programming with Lwt more convenient.

To use it, open Lwt.Infix.

Of the operators declared in this module, only >|= is recommended for new code. The only other commonly-used operator is >>=.

val (>>=) : 'a t -> ('a -> 'b t) -> 'b t

p >>= f is the same as Lwt.bind p f. It requires Lwt.Infix to be opened in scope:

open Lwt.Infix

let () =
  Lwt_main.run
    (Lwt_io.(read_line stdin) >>= Lwt_io.printl)

(* ocamlfind opt -linkpkg -package lwt.unix code.ml && ./a.out *)

It is recommended to use the PPX let%lwt syntax instead. This operator is the next-best choice. It is frequently found while reading existing Lwt code.

val (>|=) : 'a t -> ('a -> 'b) -> 'b t

p >|= f is the same as Lwt.map f p. It requires Lwt.Infix to be opened in scope.

open Lwt.Infix

let () =
  Lwt_main.run
    (Lwt_io.(read_line stdin) >|= ignore)

(* ocamlfind opt -linkpkg -package lwt.unix code.ml && ./a.out *)

val (<&>) : unit t -> unit t -> unit t

p1 <&> p2 is the same as Lwt.join [p1; p2]. It requires Lwt.Infix to be opened in scope.

Unlike with Lwt.bind and Lwt.map, there are no problems with explicit Lwt.join syntax, so using this operator is not recommended.

val (<?>) : 'a t -> 'a t -> 'a t

p1 <?> p2 is the same as Lwt.choose [p1; p2]. It requires Lwt.Infix to be opened in scope.

Unlike with Lwt.bind and Lwt.join, there are no problems with explicit Lwt.choose syntax, so using this operator is not recommended.

Futhermore, most users actually need Lwt.pick instead of Lwt.choose.

val (=<<) : ('a -> 'b t) -> 'a t -> 'b t

f =<< p is the same as Lwt.bind p f. It requires Lwt.Infix to be opened in scope.

This operator is obscure and its use is discouraged. It is the same as p >>= f.

val (=|<) : ('a -> 'b) -> 'a t -> 'b t

f =|< p is the same as Lwt.map f p. It requires Lwt.Infix to be opened in scope.

This operator is obscure and its use is discouraged. It is the same as p >|= f.

module Let_syntax : sig ... end

This module provides support for ppx_let.