Spacetime.Snapshot(3)

📦 version 4.11.1, in centos-stream 9

✨ NAME ✨

Spacetime.Snapshot — and the description? bestie, it literally says no description. That's the whole NAME section, no notes, no extras. We're in the OCaml library manual, page Spacetime.Snapshot(3), and it's giving minimal icon behavior 🎀.

🧩 Module 🧩

The module in question is Spacetime.Snapshot. That's it, that's the module. 🫶

📚 Documentation 📚

Okay so inside the docs, the module shape is literally this:

Module Snapshot
 : sig end

And then there's exactly one value, the main character:

val take : ?time:float -> Spacetime.Series.t -> unit

💅 val take 💅

take series takes a snapshot of the profiling annotations on the values in the minor and major heaps, together with GC stats, and writes the result to the series file. 💾✨

Heads up: this function triggers a minor GC, but it does not allocate any memory itself. No extra allocation, periodt.

If the optional time is specified, it will be used instead of the result of Sys.time as the timestamp of the snapshot. Those times should start from zero and be monotonically increasing. 📈

This parameter is intended to be used so that snapshots can be correlated against wall clock time (which is not supported in the standard library) rather than elapsed CPU time. iykyk 🕰️

okay bestie that's the whole page — brought to you by OCamldoc, dated 2022-03-11, and signed Spacetime.Snapshot(3) 💖✨

📦 where this page comes from