Spacetime.Series(3)

💖 NAME 💖

Okay bestie, this is the Spacetime.Series(3) page from the OCaml library manual, and the name block is literally just: Spacetime.Series — no description 😭. That's the whole name vibe. Don't shoot the messenger.

---

🧚 Module 🧚

The module is Spacetime.Series. Inner-module moment incoming.

✨ Documentation ✨

Module Series
 : sig end

🦋 type t 🦋

type t

This is the type that represents a file which will hold a series of heap snapshots, together with the additional information required to interpret those snapshots. Iconic file energy, honestly.

🌸 val create : path:string -> t 🌸

val create : path:string -> t

create ~path creates a series file at path. Simple slay.

🫶 val save_event : ?time:float -> t -> event_name:string -> unit 🫶

val save_event : ?time:float -> t -> event_name:string -> unit

save_event writes an event into the given series file. An event is just an arbitrary string, no cap. 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 👑

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

save_and_close series writes information into series required for interpreting the snapshots that series contains, and then closes the series file.

🚨 Bestie, listen: this function must be called to produce a valid series file. No skipping, no “I'll do it later”, no cap. The optional time parameter is as for Spacetime.Snapshot.take.

---

💖 That's the whole page. Source/version: OCamldoc; date: 2022-03-11. Go forth and make a valid series file, bestie! 🫶💅