Runtime_events.User(3)

📦
version 5.5.0 · 13 versions
, in arch rolling

💅 Runtime_events.User(3) 💅

okay so this one's straight out of the OCaml library manual, and honestly? it's giving "tiny module, big main-character energy" ✨

✨ NAME ✨

Runtime_events.User — no description 😭 (yes bestie, that's literally what it says, we're not making it up)

🦋 Module 🦋

Module Runtime_events.User

🌸 Documentation 🌸

Module User

: sig end

🎀 the whole vibe 🎀

So User events are literally a way for libraries to serve up runtime events that other tools can then consume — like handing your bestie the aux cord 🎧 These events can carry known data types or custom values, whichever fits. And heads up: the current maximum number of user events is 8192. That's the ceiling, no cap. 🔥

type tag = ..

The type for a user event tag — tags are how you discriminate between user events of the same type. iykyk 🏷️

type 'value t

The type for a user event. A user event describes its tag, its carried data type, and a unique string-based name. it's giving full ID card, honestly 🪪

🌈 the functions 🌈

  • val register : string -> tag -> 'value Runtime_events.Type.t -> 'value t — register name tag ty registers a brand-new event with a unique name, carrying a tag and values of type ty. one name, one event, no duplicates periodt 💅
  • val write : 'value t -> 'value -> unit — write t v emits value v for event t. simple as that, she just writes 🖊️✨
  • val name : 'a t -> string — name t is the unique identifying name of event t. it's the event's government name fr fr 🫶
  • val tag : 'a t -> tag — tag t is the associated tag of event t, when it is known. and like, an event can be unknown if it was not registered in the consumer program 👀 so don't come for her if she doesn't know her own tag, it's not a personal thing 😭
🫶 little recap for the group chat: tag discriminates, t describes (tag + data type + unique string name), register makes new ones, write emits, name tells you the name, tag tells you the tag if it's known. and the max is 8192. slay. 🌟

byeeee bestie 🦋 this page was served to you by OCamldoc, dated 2026-06-22, and yes it's still Runtime_events.User(3) — mwah 💋🎀

📦 where this page comes from