module IO::Buffered

Overview

The IO::Buffered mixin enhances an IO with input/output buffering.

The buffering behaviour can be turned on/off with the #sync= and #read_buffering= methods.

Additionally, several methods, like #gets, are implemented in a more efficient way.

Direct including types

• Compress::Deflate::Reader
• Compress::Gzip::Reader
• Compress::Zlib::Reader
• IO::FileDescriptor
• OpenSSL::SSL::Socket
• Socket

Defined in:

Instance Method Summary

• #buffer_size : Int32

  Return the buffer size used

• #buffer_size=(value)

  Set the buffer size of both the read and write buffer Cannot be changed after any of the buffers have been allocated

• #close : Nil

  Flushes and closes the underlying IO.

• #flush

  Flushes any buffered data and the underlying IO.

• #flush_on_newline=(flush_on_newline)

  Turns on/off flushing the underlying IO when a newline is written.

• #flush_on_newline? : Bool

  Determines if this IO flushes automatically when a newline is written.

• #peek : Bytes

  Returns the bytes hold in the read buffer.

• #pos : Int64

  Returns the current position (in bytes) in this IO.

• #read(slice : Bytes) : Int32

  Buffered implementation of IO#read(slice).

• #read_buffering=(read_buffering)

  Turns on/off IO read buffering.

• #read_buffering? : Bool

  Determines whether this IO buffers reads.

• #rewind

  Rewinds the underlying IO.

• #sync=(sync)

  Turns on/off IO write buffering.

• #sync? : Bool

  Determines if this IO does write buffering.

• #unbuffered_close

  Closes the wrapped IO.

• #unbuffered_flush

  Flushes the wrapped IO.

• #unbuffered_read(slice : Bytes)

  Reads at most slice.size bytes from the wrapped IO into slice.

• #unbuffered_rewind

  Rewinds the wrapped IO.

• #unbuffered_write(slice : Bytes)

  Writes at most slice.size bytes from slice into the wrapped IO.

• #write(slice : Bytes) : Nil

  Buffered implementation of IO#write(slice).

Instance Method Detail

File.write("testfile", "hello")

file = File.new("testfile")
file.pos     # => 0
file.gets(2) # => "he"
file.pos     # => 2