EMILUA(3em)

💖 EMILUA 💖

okay bestie, this is the 3em manual page for Emilua, from the Emilua reference — the Lua execution engine. buckle up, it’s giving iconic 💅✨

---

🌸 NAME 🌸

Emilua - Lua execution engine 🎀

---

✨ DESCRIPTION ✨

the DESCRIPTION section opens with this whole code block, so here it is exactly as it appears:

local mutex = require('mutex')

local function ping_sender()
    sleep(30)
    scope(function()
        scope_cleanup_push(function() ws_write_mtx:unlock() end)
        ws_write_mtx:lock()
        ws:ping()
    end)
end

local function queue_consumer()
    scope(function()
        scope_cleanup_push(function() queue_mtx:unlock() end)
        queue_mtx:lock()
        while #queue == 0 do
            queue_cond:wait(queue_mtx)
        end
        for _, e in ipairs(queue) do
            consume_item(e)
        end
        queue = {}
    end)
end

and after all that, the description lands on: A mutex. 💅

---

💅 FUNCTIONS 💅

🎀 new() → mutex 🎀

constructor time, bestie. 💖

🔒 lock(self) 🔒

locks the mutex. no cap.

Note — this suspending function does not act as an cancellation point. 😌

Note — this mutex applies dispatch semantics: if it’s possible to acquire the mutex immediately, there will be no context switch to other ready fibers. 🦋

👀 try_lock(self) → boolean 👀

tries to lock the mutex and hands back a boolean saying whether the lock acquisition was successful. ✨

Caution — it’s an error to call try_lock() if the current fiber already owns the mutex (cf. recursive_mutex(3em) for an alternative). 🙈

Note — the current fiber is never suspended. 💀

🔓 unlock(self) 🔓

unlocks the mutex. periodt. 🫶

---

source/version: Emilua 0.12.1-nixpkgs1 · date: 1980-01-01 · manual: EMILUA(3em) — that’s the whole page, bestie 💅✨