NAME

       Spacetime.Series - no description

Module

       Module   Spacetime.Series

Documentation

       Module Series
        : sig end

       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 at path .

       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 optional time parameter is as for Spacetime.Snapshot.take .

       val save_and_close : ?time:float -> t -> unit

       save_and_close  series  writes  information  into  series  required  for  interpeting  the
       snapshots  that  series  contains  and  then closes the series file. This function must be
       called  to  produce  a  valid  series  file.   The  optional  time  parameter  is  as  for
       Spacetime.Snapshot.take .