EMILUA(3em)

💖 NAME 💖

hey bestie, welcome to EMILUA(3em) from the Emilua reference crew — this page is all about Emilua, the Lua execution engine. 🫶

✨ SYNOPSIS ✨

local stream = require "stream"
stream.read_all(io_object, buffer: byte_span) -> integer

🦋 DESCRIPTION 🦋

okay so stream.read_all reads data until the buffer you gave it is full, and it blocks the current fiber until the whole thing completes or errs. no cap, it just sits there and handles it. 😭

It returns the buffer's size (number of bytes read). that's the integer in the synopsis, bestie. 💅

As https://www.boost.org/doc/libs/1_77_0/doc/html/boost_asio/reference/async_read/overload1.html in Boost.Asio:

This operation is implemented in terms of zero or more calls to the stream’s async_read_some function, and is known as a composed operation. The program must ensure that the stream performs no other read operations (such as async_read, the stream’s async_read_some function, or any other composed operations that perform reads) until this operation completes.

mwah 💋 that’s the whole vibe. This page is from Emilua 0.12.1-nixpkgs1, dated 1980-01-01 — catch you in the next fiber, bestie! 🎀