EMILUA(3em)

💖 NAME 💖

okay so bestie, welcome to the Emilua reference page for EMILUA(3em) ✨ — the NAME is Emilua - Lua execution engine, and yes this is the main character 👑.

✨ FUNCTIONS ✨

🎀 new() → pipe.read_stream

new() → pipe.read_stream
new()                    (1)
new(fd: file_descriptor) (2)

• new() (1) — default constructor. No args, just vibes 🫶.
• new(fd: file_descriptor) (2) — converts a file descriptor into a pipe end. 🦋

🌸 close(self)

Closes the pipe, periodt. It forwards the call to the Boost.Asio function with the same name — here's the doc link: <https://www.boost.org/doc/libs/1_79_0/doc/html/boost_asio/reference/basic_readable_pipe/close/overload2.html>.

Any asynchronous read operations will be cancelled immediately, and will complete with the boost::asio::error::operation_aborted error.

🦋 cancel(self)

Cancels all asynchronous operations associated with the pipe. Again, it forwards the call to the Boost.Asio function with the same name: <https://www.boost.org/doc/libs/1_79_0/doc/html/boost_asio/reference/basic_readable_pipe/cancel/overload2.html>.

This function causes all outstanding asynchronous read operations to finish immediately, and the handlers for cancelled operations will be passed the boost::asio::error::operation_aborted error.

💅 assign(self, fd: file_descriptor)

Assigns an existing native pipe to self. That's the whole assignment, no cap.

⭐ release(self) → file_descriptor

Releases ownership of the native descriptor implementation. It forwards the call to the Boost.Asio function with the same name: <https://www.boost.org/doc/libs/1_80_0/doc/html/boost_asio/reference/basic_readable_pipe/release/overload2.html>.

This function causes all outstanding asynchronous read operations to finish immediately, and the handlers for cancelled operations will be passed the boost::asio::error::operation_aborted error. Ownership of the native pipe is then transferred to the caller.

🔥 read_some(self, buffer: byte_span) → integer

Reads data from the pipe and blocks the current fiber until it completes or errs. Returns the number of bytes read. Lowkey iconic.

🌸 PROPERTIES 🌸

🧚 is_open: boolean

Whether the pipe is open. That's the vibe check, bestie. 🦋

---

okay bestie, that's the whole page 💖 source/version: Emilua 0.12.1-nixpkgs1; date: 1980-01-01. mwah, bye 👑✨