opencomputers-openos-buffer.md

buffer

Summary

Buffered file-like stream helpers used by OpenOS and SecureOS I/O wrappers.

Availability

• Repository: opencomputers
• System: openos
• Type: library

Source

• OpenComputers/src\main\resources\assets\opencomputers\loot\openos\lib\buffer.lua

Usage

local buffer = require("buffer")

API

buffer.close()

• Description: Flush pending output when needed, mark the wrapper closed, and then close the underlying stream.

buffer.close()

buffer.flush()

• Description: Write the current buffered output block to the underlying stream immediately.

buffer.flush()

buffer.lines(...)

• Description: Return an iterator that repeatedly reads records from the buffered stream.
• Parameters:
  • ...

buffer.lines(nil)

buffer.new(mode, stream)

• Description: Wrap a raw stream handle with buffering, read timeout state, and read or write mode flags.
• Parameters:
  • mode
  • stream

buffer.new(nil, nil)

buffer.read(...)

• Description: Read data using Lua-style format arguments or line mode when no format is supplied.
• Parameters:
  • ...

buffer.read(nil)

buffer.readLine(chop, timeout)

• Description: Read one line from the internal read buffer, optionally preserving the line ending.
• Parameters:
  • chop
  • timeout

buffer.readLine(nil, nil)

buffer.setvbuf(mode, size)

• Description: Configure buffering mode as no, full, or line, and optionally set the buffer size.
• Parameters:
  • mode
  • size

buffer.setvbuf(nil, nil)

buffer.write(...)

• Description: Write strings or numbers to the stream, honoring the active buffering mode.
• Parameters:
  • ...

buffer.write(nil)

Notes

• Instances returned by buffer.new wrap a lower-level stream and add line buffering, formatted reads, timeout handling, and file-like helper methods.