/usr/lib/ocaml/lwt/pa_lwt.mli is in liblwt-ocaml-dev 2.7.1-4build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 | (* Lightweight thread library for OCaml
* http://www.ocsigen.org/lwt
* Module Pa_lwt
* Copyright (C) 2009 Jérémie Dimino
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation, with linking exceptions;
* either version 2.1 of the License, or (at your option) any later
* version. See COPYING file for details.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
* 02111-1307, USA.
*)
(** Syntactic sugars for Lwt (deprecated) *)
(** This extension add the following sugars:
- anonymous bind:
{[
write stdout "Hello, " >> write stdout "world!"
]}
If you are mixing `>>` and `;`, you need to use parentheses or
`begin`/`end` to get the result you expect:
{[
write stdout "Hello, " >> (ignore (); write stdout "world!")
]}
- lwt-binding:
{[
lwt ch = get_char stdin in
code
]}
is the same as [bind (get_char stdin) (fun ch -> code)]
Moreover it supports parallel binding:
{[
lwt x = do_something1 ()
and y = do_something2 in
code
]}
will let [do_something1 ()] and [do_something2 ()] runs then
bind their result to [x] and [y]. It is the same as:
{[
let t1 = do_something1
and t2 = do_something2 in
bind t1 (fun x -> bind t2 (fun y -> code))
]}
- exception catching:
{[
try_lwt
<expr>
]},
{[
try_lwt
<expr>
with
<branches>
]},
{[
try_lwt
<expr>
finally
<expr>
]}
and:
{[
try_lwt
<expr>
with
<branches>
finally
<expr>
]}
For example:
{[
try_lwt
f x
with
| Failure msg ->
prerr_endline msg;
return ()
]}
is expanded to:
{[
catch (fun _ -> f x)
(function
| Failure msg ->
prerr_endline msg;
return ()
| exn ->
Lwt.fail exn)
]}
Note that the [exn -> Lwt.fail exn] branch is automatically addedd
when needed.
Note also that [finally] is evaluated {e before} [with] if an exception is
raised. This is not the case with the newer PPX extension: there, [finally]
is always evaluated last.
The construction [try_lwt <expr>] just catch regular exception
into lwt exception. i.e. it is the same as [catch (fun _ -> <expr>) fail].
- exception raising:
{[
raise_lwt <expr>
]}
This allow exception to be traced when the -lwt-debug switch is passed
to the syntax extension.
- assertion:
{[
assert_lwt <expr>
]}
- for loop:
{[
for_lwt i = <expr> to <expr> do
<expr>
done
]}
and:
{[
for_lwt i = <expr> downto <expr> do
<expr>
done
]}
- iteration over streams:
{[
for_lwt <patt> in <expr> do
<expr>
done
]}
- while loop:
{[
while_lwt <expr> do
<expr>
done
]}
- pattern matching:
{[
match_lwt <expr> with
| <patt_1> -> <expr_1>
...
| <patt_n> -> <expr_n>
]}
*)
|