GOLF(2gg)

📦 version 601.4.41, in ubuntu questing

💅 NAME 💅

SEMI — the Golf documentation, but make it messages 🫶

✨ DESCRIPTION ✨

okay bestie sit down because SEMI is literally the moment. it stands for SimplE Message Interface and it's a binary format used to write (pack) and read (unpack) messages — and those messages are just key/value pairs hanging out together, looking like this:

<key>=<8 byte length of value><value>

so <key> can be made of any characters you want… except the equal sign ("=") and the exclamation point ("!"), those two are NOT invited. 🚫 and any whitespace chilling around the edges gets trimmed off. bye. ✂️

the value is always preceded by an 8-byte length of value — that's a binary number in big-endian 64bit format — and then the value itself shows up, and then a new line ("\n") at the end, and bestie listen: that newline is not counted in the length. periodt. 💅

there's one special <key> and it's "comment" — it's always ignored, it exists purely so you can leave little notes for yourself, general commenting energy only. 🎀

and the way that SEMI implicitly supports binary data with zero need for any kind of encoding?? iconic. because the number of bytes is specified ahead of the value, parsing stays efficient. no cap. 🔥

🌈 SEE ALSO 🌈

  • Messages
  • get-message
  • new-message
  • read-message
  • SEMI
  • write-message
  • See all documentation

okay that's the whole vibe, go pack some messages and slay 💖 this was the GOLF(2gg) page from the Development section, brought to you on $DATE at version $VERSION — mwah, ily, drink water 🦋✨

📦 where this page comes from