1Spacetime.Series(3)              OCaml library             Spacetime.Series(3)
2
3
4

NAME

6       Spacetime.Series - no description
7

Module

9       Module   Spacetime.Series
10

Documentation

12       Module Series
13        : sig end
14
15
16
17
18
19
20
21       type t
22
23
24       Type  representing a file that will hold a series of heap snapshots to‐
25       gether with additional information required to  interpret  those  snap‐
26       shots.
27
28
29
30       val create : path:string -> t
31
32
33       create ~path creates a series file at path .
34
35
36
37       val save_event : ?time:float -> t -> event_name:string -> unit
38
39
40       save_event  writes  an  event,  which  is an arbitrary string, into the
41       given series file.  This may be used for identifying particular  points
42       during program execution when analysing the profile.  The optional time
43       parameter is as for Spacetime.Snapshot.take .
44
45
46
47       val save_and_close : ?time:float -> t -> unit
48
49
50       save_and_close series writes information into series required  for  in‐
51       terpreting  the  snapshots that series contains and then closes the se‐
52       ries file. This function must be called to produce a valid series file.
53       The optional time parameter is as for Spacetime.Snapshot.take .
54
55
56
57
58
59OCamldoc                          2021-01-26               Spacetime.Series(3)
Impressum