GOLF(2gg)

🎀 GOLF(2gg) — return-handler 💖

okay bestie, gather round, because this one is so important and it's giving main character energy for real.

✨ NAME ✨

return-handler — (program-flow) 🌸

---

💅 PURPOSE 💅

Bounce out of the request handler you're currently in and go back to whoever called you. that's it. that's the whole vibe. 🦋

---

✨ SYNTAX ✨

return-handler  [ <return value> ]

---

🌈 DESCRIPTION 🌈

so return-handler returns from the current request handler by handing control back to its caller. simple! iconic! 💖

but here's where it gets spicy, because how it returns depends on what kind of request you're handling:

• If the current request handler is handling an external request (like from a web browser, an API, a command line, etc.), then return-handler is literally equivalent to exit-handler. same thing, no cap. ✨
• If the current request handler was handling an internal request — meaning it got called from another request handler via call-handler — then control transfers back to that handler immediately after the call-handler. like, right after. no detours. 🫶

For internal requests, that number <return value> gets passed back to the caller, and the caller can grab it with the "return-value" clause in call-handler. 👑

• If <return value> is omitted, it's assumed to be 0. default behavior, we love her. 💜
• If the current request handler is handling an external request, then <return value> will also set the handler's exit status (peep exit-status and exit-handler for the deets). 🔥

---

🍓 EXAMPLES 🍓

In this example, "req-handler" (the caller) will call "other-handler" (the callee), and the callee will return to the caller — immediately after call-handler. here's the caller, slaying:

begin-handler /req-handler public
    ...
    call-handler "/other-handler" return-value rval
    ...
end-handler

and here's the callee handler, doing her little exit:

begin-handler /other-handler public
    ...
    return-handler 5
    ...
end-handler

The value of "rval" in the caller will be 5. ✨ that's it, that's the magic. 💫

---

🦋 SEE ALSO 🦋

Program flow

break-loop call-handler code-blocks continue-loop do-once exit-handler if-defined if-true quit-process return-handler start-loop — See all documentation 💖

---

mwah, that's the whole page bestie 💜 this one came from the $DATE drop, version $VERSION, filed under GOLF(2gg) — go forth and return-handler responsibly, ily 🎀✨