ri > Net::SSH::Buffer

= Net::SSH::Buffer < Object

(from /home/chedong/.local/share/rdoc)
------------------------------------------------------------------------
Net::SSH::Buffer is a flexible class for building and parsing binary
data packets. It provides a stream-like interface for sequentially
reading data items from the buffer, as well as a useful helper method
for building binary packets given a signature.

Writing to a buffer always appends to the end, regardless of where the
read cursor is. Reading, on the other hand, always begins at the first
byte of the buffer and increments the read cursor, with subsequent reads
taking up where the last left off.

As a consumer of the Net::SSH library, you will rarely come into contact
with these buffer objects directly, but it could happen. Also, if you
are ever implementing a protocol on top of SSH (e.g. SFTP), this buffer
class can be quite handy.
------------------------------------------------------------------------
= Class methods:

  from
  new

= Instance methods:

  ==
  append
  available
  clear!
  consume!
  content
  empty?
  eof?
  length
  position
  read
  read!
  read_all
  read_bignum
  read_bool
  read_buffer
  read_byte
  read_int64
  read_key
  read_keyblob
  read_long
  read_private_keyblob
  read_string
  read_to
  remainder_as_buffer
  reset!
  to_s
  write
  write_bignum
  write_bool
  write_byte
  write_int64
  write_key
  write_long
  write_moved
  write_mstring
  write_string

= Attributes:

  attr_accessor position
  attr_reader content