1Stdlib.Lazy(3)                   OCaml library                  Stdlib.Lazy(3)
2
3
4

NAME

6       Stdlib.Lazy - no description
7

Module

9       Module   Stdlib.Lazy
10

Documentation

12       Module Lazy
13        : (module Stdlib__lazy)
14
15
16
17
18
19
20
21       type 'a t = 'a CamlinternalLazy.t
22
23
24       A  value  of type 'a Lazy.t is a deferred computation, called a suspen‐
25       sion, that has a result of type 'a .   The  special  expression  syntax
26       lazy  (expr)  makes  a  suspension of the computation of expr , without
27       computing expr itself yet.  "Forcing" the suspension will then  compute
28       expr and return its result. Matching a suspension with the special pat‐
29       tern syntax lazy(pattern) also computes the underlying  expression  and
30       tries to bind it to pattern :
31
32
33           let lazy_option_map f x =
34           match x with
35           | lazy (Some x) -> Some (Lazy.force f x)
36           | _ -> None
37
38
39       Note:  If lazy patterns appear in multiple cases in a pattern-matching,
40       lazy expressions may be forced even  outside  of  the  case  ultimately
41       selected  by the pattern matching. In the example above, the suspension
42       x is always computed.
43
44       Note: lazy_t is the built-in type constructor used by the compiler  for
45       the  lazy  keyword.  You should not use it directly.  Always use Lazy.t
46       instead.
47
48       Note: Lazy.force is not thread-safe.  If  you  use  this  module  in  a
49       multi-threaded program, you will need to add some locks.
50
51       Note: if the program is compiled with the -rectypes option, ill-founded
52       recursive definitions of the form let rec x = lazy x or  let  rec  x  =
53       lazy(lazy(...(lazy x))) are accepted by the type-checker and lead, when
54       forced, to ill-formed values that trigger infinite loops in the garbage
55       collector  and  other  parts of the run-time system.  Without the -rec‐
56       types option, such ill-founded recursive definitions  are  rejected  by
57       the type-checker.
58
59
60
61       exception Undefined
62
63
64
65
66
67       val force : 'a t -> 'a
68
69
70       force  x  forces  the  suspension  x  and returns its result.  If x has
71       already been forced, Lazy.force x returns the same value again  without
72       recomputing  it.   If  it  raised  an  exception, the same exception is
73       raised again.  Raise Lazy.Undefined if the forcing of x tries to  force
74       x itself recursively.
75
76
77
78       val force_val : 'a t -> 'a
79
80
81       force_val  x  forces the suspension x and returns its result.  If x has
82       already been forced, force_val x returns the same value  again  without
83       recomputing  it.   Raise  Lazy.Undefined  if  the forcing of x tries to
84       force x itself recursively.  If the computation of x raises  an  excep‐
85       tion,  it  is unspecified whether force_val x raises the same exception
86       or Lazy.Undefined .
87
88
89
90       val from_fun : (unit -> 'a) -> 'a t
91
92
93       from_fun f is the same as lazy (f ()) but slightly more efficient.
94
95
96       from_fun should only be used if the function f is already defined.   In
97       particular  it  is  always  less efficient to write from_fun (fun () ->
98       expr) than lazy expr .
99
100
101       Since 4.00.0
102
103
104
105       val from_val : 'a -> 'a t
106
107
108       from_val v returns an already-forced suspension of v  .   This  is  for
109       special purposes only and should not be confused with lazy (v) .
110
111
112       Since 4.00.0
113
114
115
116       val is_val : 'a t -> bool
117
118
119       is_val x returns true if x has already been forced and did not raise an
120       exception.
121
122
123       Since 4.00.0
124
125
126
127       val lazy_from_fun : (unit -> 'a) -> 'a t
128
129       Deprecated.  synonym for from_fun .
130
131
132
133       val lazy_from_val : 'a -> 'a t
134
135       Deprecated.  synonym for from_val .
136
137
138
139       val lazy_is_val : 'a t -> bool
140
141       Deprecated.  synonym for is_val .
142
143
144
145
146
147OCamldoc                          2020-02-27                    Stdlib.Lazy(3)