summaryrefslogtreecommitdiff
path: root/lib/readbytes.rb
diff options
context:
space:
mode:
authormatz <matz@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2006-07-31 06:31:38 +0000
committermatz <matz@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2006-07-31 06:31:38 +0000
commit4c86e4a580fc172b0f524a371c133d6d990022d0 (patch)
tree9ea49b57c1045fa5e5e912cd8f03a2e3d722db83 /lib/readbytes.rb
parentddc38a6abbd94df58a99c6aff43e4ab71a7132a2 (diff)
* lib/logger.rb: improves the amount of documentation that Rdoc
picks up when processing logger.rb by moving the require statement back before the comment block. a patch from Hugh Sasse <hgs at dmu.ac.uk>. [ruby-core:08422] git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@10647 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'lib/readbytes.rb')
-rw-r--r--lib/readbytes.rb5
1 files changed, 5 insertions, 0 deletions
diff --git a/lib/readbytes.rb b/lib/readbytes.rb
index d6a3b10..08b92da 100644
--- a/lib/readbytes.rb
+++ b/lib/readbytes.rb
@@ -12,6 +12,11 @@ class TruncatedDataError<IOError
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.
def readbytes(n)
str = read(n)
if str == nil