summaryrefslogtreecommitdiff
path: root/lib/readbytes.rb
diff options
context:
space:
mode:
authordrbrain <drbrain@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2006-08-04 18:05:50 +0000
committerdrbrain <drbrain@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2006-08-04 18:05:50 +0000
commit52c034aecb365c6cf2a41b8648c3e87fb335fdaf (patch)
tree199813273b1cd9a90b40e3dc797303d0e5f8c67b /lib/readbytes.rb
parent4db2df633cc784c40e21b3df38fe9a6dd1b0ff0b (diff)
Documentation cleanup.
Includes patches by Hugh Sasse: * ping.rb * weakref.rb * mailread.rb git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@10668 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'lib/readbytes.rb')
-rw-r--r--lib/readbytes.rb20
1 files changed, 10 insertions, 10 deletions
diff --git a/lib/readbytes.rb b/lib/readbytes.rb
index 08b92da..ebb5fc0 100644
--- a/lib/readbytes.rb
+++ b/lib/readbytes.rb
@@ -1,22 +1,22 @@
-# readbytes.rb
-#
-# add IO#readbytes, which reads fixed sized data.
-# it guarantees read data size.
+# TruncatedDataError is raised when IO#readbytes fails to read enough data.
class TruncatedDataError<IOError
- def initialize(mesg, data)
+ def initialize(mesg, data) # :nodoc:
@data = data
super(mesg)
end
+
+ # The read portion of an IO#readbytes attempt.
attr_reader :data
end
class IO
- # reads exactly n bytes from the IO stream.
- # If the data read is nil, raises EOFError.
- # If the data read is too short, raises TruncatedDataError.
- # The method TruncatedDataError#data may be used to obtain
- # the truncated message.
+ # Reads exactly +n+ bytes.
+ #
+ # If the data read is nil an EOFError is raised.
+ #
+ # If the data read is too short a TruncatedDataError is raised and the read
+ # data is obtainable via its #data method.
def readbytes(n)
str = read(n)
if str == nil