type t
Type representing a file that will hold a series of heap snapshots together with additional information required to interpret those snapshots.
val create : path:string -> t
create ~path
creates a series file atpath
.
val save_event : ?time:float -> t -> event_name:string -> unit
save_event
writes an event, which is an arbitrary string, into the given series file. This may be used for identifying particular points during program execution when analysing the profile. The optionaltime
parameter is as forSnapshot.take
.
val save_and_close : ?time:float -> t -> unit
save_and_close series
writes information intoseries
required for interpreting the snapshots thatseries
contains and then closes theseries
file. This function must be called to produce a valid series file. The optionaltime
parameter is as forSnapshot.take
.