Streams

Stream read/write operations for handling data efficiently. Stream objects are obtained from other modules (HTTP, filesystem, etc.).

Loading

-- From HTTP request body
local stream = req:stream()

-- From filesystem
local fs = require("fs")
local stream = fs.get("app:data"):open("/file.txt", "r")

Reading

local chunk, err = stream:read(size)

Returns: string, error — nil on EOF

-- Read all remaining data
local data, err = stream:read_all()

Writing

local bytes, err = stream:write(data)

Returns: integer, error — bytes written

Seeking

local pos, err = stream:seek(whence, offset)

Returns: integer, error — new position

Flushing

local ok, err = stream:flush()

Flush buffered data to underlying storage.

Stream Info

local info, err = stream:stat()

Closing

local ok, err = stream:close()

Close stream and release resources. Safe to call multiple times.

Scanner

Create a tokenizer for stream content:

local scanner, err = stream:scanner(split)

Scanner Methods

local has_more = scanner:scan()  -- Advance to next token
local token = scanner:text()      -- Get current token
local err_msg = scanner:err()     -- Get error if any

while scanner:scan() do
    local line = scanner:text()
    process(line)
end
if scanner:err() then
    return nil, errors.new("INTERNAL", scanner:err())
end

Errors