read(p1 = v1, p2 = v2) public

Reads length bytes from the I/O stream.

length must be a non-negative integer or nil.

If length is a positive integer, read tries to read length bytes without any conversion (binary mode). It returns nil if an EOF is encountered before anything can be read. Fewer than length bytes are returned if an EOF is encountered during the read. In the case of an integer length, the resulting string is always in ASCII-8BIT encoding.

If length is omitted or is nil, it reads until EOF and the encoding conversion is applied, if applicable. A string is returned even if EOF is encountered before any data is read.

If length is zero, it returns an empty string (“”).

If the optional outbuf argument is present, it must reference a String, which will receive the data. The outbuf will contain only the received data after the method call even if it is not empty at the beginning.

When this method is called at end of file, it returns nil or “”, depending on length: read, read(nil), and read(0) return “”, read(positive_integer) returns nil.

f ="testfile")   #=> "This is line one"

# read whole file
open("file") do |f|
  data =   # This returns a string even if the file is empty.
  # ...

# iterate over fixed length records
open("fixed-record-file") do |f|
  while record =
    # ...

# iterate over variable length records,
# each record is prefixed by its 32-bit length
open("variable-record-file") do |f|
  while len =
    len = len.unpack("N")[0]   # 32-bit length
    record =       # This returns a string even if len is 0.

Note that this method behaves like the fread() function in C. This means it retries to invoke read(2) system calls to read data with the specified length (or until EOF). This behavior is preserved even if ios is in non-blocking mode. (This method is non-blocking flag insensitive as other methods.) If you need the behavior like a single read(2) system call, consider #readpartial, #read_nonblock, and #sysread.

Show source
Register or log in to add new notes.