diff options
author | matz <matz@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2006-07-31 06:31:38 +0000 |
---|---|---|
committer | matz <matz@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2006-07-31 06:31:38 +0000 |
commit | d40b4d352eafa247f0288f89efc8da2f73ea2b91 (patch) | |
tree | 9ea49b57c1045fa5e5e912cd8f03a2e3d722db83 /lib/readbytes.rb | |
parent | df86fe489e88eada04009c19380038afd2cdcb8e (diff) | |
download | ruby-d40b4d352eafa247f0288f89efc8da2f73ea2b91.tar.gz ruby-d40b4d352eafa247f0288f89efc8da2f73ea2b91.tar.xz ruby-d40b4d352eafa247f0288f89efc8da2f73ea2b91.zip |
* 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: http://svn.ruby-lang.org/repos/ruby/trunk@10647 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'lib/readbytes.rb')
-rw-r--r-- | lib/readbytes.rb | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/lib/readbytes.rb b/lib/readbytes.rb index d6a3b10af..08b92da73 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 |